2013-04-25 23:43:19 -07:00
|
|
|
[![Build Status](https://travis-ci.org/jedisct1/libsodium.png?branch=master)](https://travis-ci.org/jedisct1/libsodium?branch=master)
|
2014-06-28 18:48:53 -07:00
|
|
|
[![Coverity Scan Build Status](https://scan.coverity.com/projects/2397/badge.svg)](https://scan.coverity.com/projects/2397)
|
2013-04-25 23:43:19 -07:00
|
|
|
|
2013-01-31 00:25:02 -07:00
|
|
|
![libsodium](https://raw.github.com/jedisct1/libsodium/master/logo.png)
|
2013-01-31 00:16:54 -07:00
|
|
|
============
|
2013-01-20 01:03:34 -07:00
|
|
|
|
2014-06-28 22:49:18 -07:00
|
|
|
Sodium is a new, easy-to-use software library for encryption,
|
|
|
|
decryption, signatures, password hashing and more.
|
2013-01-20 01:03:34 -07:00
|
|
|
|
2014-06-28 22:49:18 -07: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 17:56:17 -07:00
|
|
|
|
2014-06-28 22:49:18 -07:00
|
|
|
Its goal is to provide all of the core operations needed to build
|
|
|
|
higher-level cryptographic tools.
|
2013-01-20 17:56:17 -07:00
|
|
|
|
2014-06-28 22:49:18 -07:00
|
|
|
Sodium supports a variety of compilers and operating systems,
|
2013-10-21 22:25:33 -07:00
|
|
|
including Windows (with MingW or Visual Studio, x86 and x64), iOS and Android.
|
2013-01-20 17:56:17 -07:00
|
|
|
|
2014-06-28 22:49:18 -07:00
|
|
|
## Documentation
|
2014-05-08 14:19:46 -07:00
|
|
|
|
2014-06-28 22:49:18 -07:00
|
|
|
The documentation is a work-in-progress, and is being written using
|
|
|
|
Gitbook:
|
2014-05-08 14:19:46 -07:00
|
|
|
|
2015-05-07 21:53:59 -07:00
|
|
|
[libsodium documentation](https://download.libsodium.org/doc/)
|
2013-07-29 09:37:42 -07:00
|
|
|
|
2014-06-28 22:50:51 -07:00
|
|
|
## Community
|
|
|
|
|
|
|
|
A mailing-list is available to discuss libsodium.
|
|
|
|
|
2014-06-28 22:51:39 -07:00
|
|
|
In order to join, just send a random mail to `sodium-subscribe` {at}
|
|
|
|
`pureftpd` {dot} `org`.
|
2014-06-28 22:50:51 -07:00
|
|
|
|
2013-07-29 09:37:42 -07:00
|
|
|
## License
|
|
|
|
|
2015-05-07 21:53:59 -07:00
|
|
|
[ISC license](https://en.wikipedia.org/wiki/ISC_license).
|