libsodium README

The project's README from github.com/jedisct1/libsodium. As one markdown file: README.md.

GitHub CI Coverity Scan Build Status Azure build status CodeQL scan

libsodium

Sodium is an easy-to-use software library that provides a wide range of cryptographic operations including encryption, decryption, digital signatures, and secure password hashing.

It is a portable, cross-compilable, installable, and packageable fork of NaCl. While maintaining API compatibility, libsodium extends functionality to improve usability and simplify the development of secure applications.


Key Features


Documentation


Versioning

libsodium uses a two-tier release system:

If your application depends on a specific point release, stable updates are safe to apply. Security fixes go to the stable branch immediately, with a new point release tagged shortly after.


Contributors

Code Contributors

This project thrives thanks to the valuable contributions from our community. View all the contributors:

Contributors

Financial Contributors

Your financial support helps us sustain and further develop libsodium.

Individuals

Individual Contributors

Organizations

Support libsodium with your organization and gain visibility through your logo and website link.

Organization Contributor

License

This project is distributed under the ISC license.

libsodium (jedisct1/libsodium)

Searching Database…

What is this?Libsodium is an easy-to-use software library providing cryptographic operations like encryption, decryption, digital signatures, and secure password hashing. It is a portable, cross-compilable fork of NaCl that keeps API compatibility while improving usability.
Is this a library I link into my own app, or a standalone tool?It is a C library you compile or install and link into your own application; there is no standalone CLI or GUI, you call its API from your code.
How do I add libsodium to my project?Install it via your platform's package manager or build it from source, then link against it; the README points to dedicated Installation and Quickstart docs for exact steps.
Do I need any special build tools to compile it?On Windows it builds with MinGW or Visual Studio; otherwise it follows the standard C toolchain for your platform (configure/make or equivalent per the install docs).
If I pin to a specific release, will updates break my build?No — stable branch updates only fix minor issues and stay fully compatible with their parent point release, with no new features or breaking changes; new features only arrive in point releases.
Which platforms and architectures does it actually support?Windows (MinGW and Visual Studio, x86, x64, arm64), iOS, Android, plus JavaScript and WebAssembly builds for browser/Node use.
How are security fixes handled across versions?Security fixes go straight to the stable branch immediately, and a corresponding new point release is tagged shortly afterward.
Why use this instead of raw NaCl?Libsodium keeps NaCl's API compatibility but extends functionality and improves usability, making it easier to build secure applications correctly.
Can I verify downloaded releases are untampered?Yes, the project provides dedicated Integrity Checking documentation alongside its Installation and Releases pages for verifying downloads.
What are similar projects?openssl, tink, gun, hashsigs-rs, coturn, jwt-go, CryptoSwift, ente
Creator
jedisct1
Size
13.3 MB
Stars
14K
Age
13y
Commits · 90 Days