2015-11-18 16:55:40 -05:00
|
|
|
[](https://travis-ci.org/jedisct1/libsodium?branch=master)
|
2016-01-11 05:20:58 -05:00
|
|
|
[](https://ci.appveyor.com/project/jedisct1/libsodium)
|
2019-01-30 12:46:49 -05:00
|
|
|
[](https://scan.coverity.com/projects/2397)
|
2019-05-29 09:42:06 -04:00
|
|
|
[](https://dev.azure.com/jedisct1/testing-azure-pipelines/_build/latest?definitionId=2&branchName=stable)
|
2013-04-26 02:43:19 -04:00
|
|
|
|
2013-01-31 02:25:02 -05:00
|
|
|
|
2013-01-31 02:16:54 -05:00
|
|
|
============
|
2013-01-20 03:03:34 -05:00
|
|
|
|
2014-06-29 01:49:18 -04:00
|
|
|
Sodium is a new, easy-to-use software library for encryption,
|
|
|
|
|
decryption, signatures, password hashing and more.
|
2013-01-20 03:03:34 -05:00
|
|
|
|
2014-06-29 01:49:18 -04:00
|
|
|
It is a portable, cross-compilable, installable, packageable
|
|
|
|
|
fork of [NaCl](http://nacl.cr.yp.to/), with a compatible API, and an
|
|
|
|
|
extended API to improve usability even further.
|
2013-01-20 19:56:17 -05:00
|
|
|
|
2014-06-29 01:49:18 -04:00
|
|
|
Its goal is to provide all of the core operations needed to build
|
|
|
|
|
higher-level cryptographic tools.
|
2013-01-20 19:56:17 -05:00
|
|
|
|
2014-06-29 01:49:18 -04:00
|
|
|
Sodium supports a variety of compilers and operating systems,
|
2017-10-18 13:23:59 -04:00
|
|
|
including Windows (with MingW or Visual Studio, x86 and x64), iOS, Android,
|
|
|
|
|
as well as Javascript and Webassembly.
|
2013-01-20 19:56:17 -05:00
|
|
|
|
2014-06-29 01:49:18 -04:00
|
|
|
## Documentation
|
2014-05-08 17:19:46 -04:00
|
|
|
|
2018-02-07 11:47:03 -05:00
|
|
|
The documentation is available on Gitbook and built from the [libsodium-doc](https://github.com/jedisct1/libsodium-doc) repository:
|
2014-05-08 17:19:46 -04:00
|
|
|
|
2015-12-23 21:39:41 -05:00
|
|
|
* [libsodium documentation](https://download.libsodium.org/doc/) -
|
|
|
|
|
online, requires Javascript.
|
|
|
|
|
* [offline documentation](https://www.gitbook.com/book/jedisct1/libsodium/details)
|
2019-01-06 09:55:36 -05:00
|
|
|
in PDF format.
|
2013-07-29 12:37:42 -04:00
|
|
|
|
2016-03-17 18:20:59 -04:00
|
|
|
## Integrity Checking
|
|
|
|
|
|
2016-03-17 18:26:02 -04:00
|
|
|
The integrity checking instructions (including the signing key for libsodium)
|
2018-11-06 11:40:11 -05:00
|
|
|
are available in the [installation](https://download.libsodium.org/doc/installation#integrity-checking)
|
2016-03-17 18:27:08 -04:00
|
|
|
section of the documentation.
|
2016-03-17 18:20:59 -04:00
|
|
|
|
2014-06-29 01:50:51 -04:00
|
|
|
## Community
|
|
|
|
|
|
|
|
|
|
A mailing-list is available to discuss libsodium.
|
|
|
|
|
|
2014-06-29 01:51:39 -04:00
|
|
|
In order to join, just send a random mail to `sodium-subscribe` {at}
|
|
|
|
|
`pureftpd` {dot} `org`.
|
2014-06-29 01:50:51 -04:00
|
|
|
|
2013-07-29 12:37:42 -04:00
|
|
|
## License
|
|
|
|
|
|
2015-05-08 00:53:59 -04:00
|
|
|
[ISC license](https://en.wikipedia.org/wiki/ISC_license).
|
