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 语言库,你需要编译或安装它,并把它链接到你自己的应用中;没有独立的命令行或图形界面,你在代码里调用它的 API 即可。
我该如何把 libsodium 添加到我的项目中?通过你所用平台的包管理器安装,或从源码编译,然后进行链接;具体步骤请参考 README 中指向的专门安装文档和快速入门文档。
编译它需要什么特殊的构建工具吗?在 Windows 上,它可以使用 MinGW 或 Visual Studio 构建;在其他平台上,则遵循你所在平台的标准 C 工具链(按照安装文档使用 configure/make 或同类工具)。
如果我固定使用某个特定版本,更新会破坏我的构建吗?不会。稳定分支的更新只修复小问题,并且与其所属的父级point release完全兼容,不会引入新功能或破坏性变更;新功能只会在point release中出现。
它实际支持哪些平台和架构?Windows(MinGW 和 Visual Studio,支持 x86、x64、arm64)、iOS、Android,以及用于浏览器或 Node 环境的 JavaScript 和 WebAssembly 构建。
各个版本的安全修复是如何处理的?安全修复会直接合入稳定分支,并在随后不久发布一个对应的新 point release 标签。
为什么要用它而不是原始的 NaCl?Libsodium 保持了与 NaCl 的 API 兼容,同时扩展了功能并提升了易用性,让人更容易正确地构建安全应用。
我能验证下载的发布版本是否被篡改过吗?可以。项目在安装和发布页面之外,还提供了专门的完整性校验(Integrity Checking)文档,用于验证下载文件。
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