xref: /freebsd/sys/contrib/libsodium/README.markdown (revision 3611ec604864a7d4dcc9a3ea898c80eb35eef8a0)
1*0ac341f1SConrad Meyer[![Build Status](https://travis-ci.org/jedisct1/libsodium.svg?branch=master)](https://travis-ci.org/jedisct1/libsodium?branch=master)
2*0ac341f1SConrad Meyer[![Windows build status](https://ci.appveyor.com/api/projects/status/fu8s2elx25il98hj?svg=true)](https://ci.appveyor.com/project/jedisct1/libsodium)
3*0ac341f1SConrad Meyer[![Coverity Scan Build Status](https://scan.coverity.com/projects/2397/badge.svg)](https://scan.coverity.com/projects/2397)
4*0ac341f1SConrad Meyer
5*0ac341f1SConrad Meyer![libsodium](https://raw.github.com/jedisct1/libsodium/master/logo.png)
6*0ac341f1SConrad Meyer============
7*0ac341f1SConrad Meyer
8*0ac341f1SConrad MeyerSodium is a new, easy-to-use software library for encryption,
9*0ac341f1SConrad Meyerdecryption, signatures, password hashing and more.
10*0ac341f1SConrad Meyer
11*0ac341f1SConrad MeyerIt is a portable, cross-compilable, installable, packageable
12*0ac341f1SConrad Meyerfork of [NaCl](http://nacl.cr.yp.to/), with a compatible API, and an
13*0ac341f1SConrad Meyerextended API to improve usability even further.
14*0ac341f1SConrad Meyer
15*0ac341f1SConrad MeyerIts goal is to provide all of the core operations needed to build
16*0ac341f1SConrad Meyerhigher-level cryptographic tools.
17*0ac341f1SConrad Meyer
18*0ac341f1SConrad MeyerSodium supports a variety of compilers and operating systems,
19*0ac341f1SConrad Meyerincluding Windows (with MingW or Visual Studio, x86 and x64), iOS, Android,
20*0ac341f1SConrad Meyeras well as Javascript and Webassembly.
21*0ac341f1SConrad Meyer
22*0ac341f1SConrad Meyer## Documentation
23*0ac341f1SConrad Meyer
24*0ac341f1SConrad MeyerThe documentation is available on Gitbook and built from the [libsodium-doc](https://github.com/jedisct1/libsodium-doc) repository:
25*0ac341f1SConrad Meyer
26*0ac341f1SConrad Meyer* [libsodium documentation](https://download.libsodium.org/doc/) -
27*0ac341f1SConrad Meyeronline, requires Javascript.
28*0ac341f1SConrad Meyer* [offline documentation](https://www.gitbook.com/book/jedisct1/libsodium/details)
29*0ac341f1SConrad Meyerin PDF, MOBI and ePUB formats.
30*0ac341f1SConrad Meyer
31*0ac341f1SConrad Meyer## Integrity Checking
32*0ac341f1SConrad Meyer
33*0ac341f1SConrad MeyerThe integrity checking instructions (including the signing key for libsodium)
34*0ac341f1SConrad Meyerare available in the [installation](https://download.libsodium.org/doc/installation/index.html#integrity-checking)
35*0ac341f1SConrad Meyersection of the documentation.
36*0ac341f1SConrad Meyer
37*0ac341f1SConrad Meyer## Community
38*0ac341f1SConrad Meyer
39*0ac341f1SConrad MeyerA mailing-list is available to discuss libsodium.
40*0ac341f1SConrad Meyer
41*0ac341f1SConrad MeyerIn order to join, just send a random mail to `sodium-subscribe` {at}
42*0ac341f1SConrad Meyer`pureftpd` {dot} `org`.
43*0ac341f1SConrad Meyer
44*0ac341f1SConrad Meyer## License
45*0ac341f1SConrad Meyer
46*0ac341f1SConrad Meyer[ISC license](https://en.wikipedia.org/wiki/ISC_license).
47