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…

Что это такое?Libsodium — это простая в использовании программная библиотека для криптографических операций: шифрования, расшифровки, цифровых подписей и безопасного хеширования паролей. Это переносимый, кросс-компилируемый форк NaCl, который сохраняет совместимость API и при этом улучшает удобство использования.
Это библиотека, которую я подключаю к своему приложению, или отдельная утилита?Это библиотека на C, которую нужно собрать или установить и подключить к своему приложению. Отдельного CLI или GUI нет: API вызывается прямо из вашего кода.
Как добавить libsodium в мой проект?Установите библиотеку через менеджер пакетов вашей платформы или соберите из исходников, затем подключите её. В README даны ссылки на отдельные документы Installation и Quickstart с точными шагами.
Нужны ли особые инструменты сборки, чтобы её скомпилировать?В Windows сборка идёт через MinGW или Visual Studio. В остальных случаях используется стандартный набор инструментов C для вашей платформы (configure/make или аналог, согласно документации по установке).
Если я зафиксирую конкретную версию, обновления сломают мою сборку?Нет. Обновления стабильной ветки только исправляют мелкие проблемы и полностью совместимы с родительским точечным релизом: без новых функций и без ломающих изменений. Новые функции появляются только в точечных релизах.
Какие платформы и архитектуры поддерживаются на самом деле?Windows (MinGW и Visual Studio, x86, x64, arm64), iOS, Android, а также сборки для JavaScript и WebAssembly для использования в браузере и Node.
Как выпускаются исправления безопасности для разных версий?Исправления безопасности сразу попадают в стабильную ветку, а вскоре после этого выпускается соответствующий новый точечный релиз с меткой (тегом).
Зачем использовать это вместо чистого NaCl?Libsodium сохраняет совместимость с API NaCl, но расширяет функциональность и улучшает удобство, что упрощает правильную разработку безопасных приложений.
Можно ли проверить, что скачанные релизы не подменены?Да, в проекте есть отдельная документация Integrity Checking рядом со страницами Installation и Releases, которая поможет проверить скачанные файлы.
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