jedisct1 / libsodium-doc

Gitbook documentation for libsodium

The Sodium crypto library (libsodium)

Sodium is a modern, easy-to-use software library for encryption, decryption, signatures, password hashing, and more.

It is a portable, cross-compilable, installable, and packageable fork of NaCl, with a compatible but extended API to improve usability even further.

Its goal is to provide all of the core operations needed to build higher-level cryptographic tools.

Sodium is cross-platform and cross-language. It runs on many compilers and operating systems, including Windows (with MinGW or Visual Studio, x86 and x86_64), iOS, and Android. JavaScript and WebAssembly versions are also available and fully supported. Furthermore, bindings for all common programming languages are available and well-supported.

The design choices emphasize security and ease of use. But despite the emphasis on high security, primitives are faster across-the-board than most implementations.

Downloading libsodium

libsodium 1.0.20-stable is the latest version.

• Tarballs and pre-compiled binaries
• GitHub repository
• Documentation

Mailing list

A mailing list is available to discuss libsodium.

To join, just send a random email to sodium-subscribe {at} pureftpd{dot}org.

License

ISC license.

See the LICENSE file for details.

Thanks!

Sodium is developed by volunteers. We would like to especially thank the following companies and organizations for their contribution:

• Paragonie Initiative Enterprise, who donated a Raspberry Pi to ensure that the library works perfectly on this hardware. Thanks!
• Private Internet Access, who sponsored a complete security audit. This is amazing, thanks!
• Maximilian Blochberger and Joshua Small, who both generously donated $100. This will help cover the infrastructure costs a lot. Thanks again, Max and Joshua!

People who designed the primitives and wrote implementations the library is based on can be found in the AUTHORS file. This project wouldn’t exist without them.

Also, a huge “thank you” to people and companies who contributed bindings for their favorite programming languages. A list can be found in the THANKS file.

Another huge “thank you” to package maintainers who have been doing an amazing job at building packages for many distributions and operating systems.

Finally, thanks to you for reading this documentation and for the awesome projects you are going to build with this library!