2020-02-05 16:59:07 -07:00
[![Build Status ](https://travis-ci.com/jedisct1/libsodium.svg?branch=master )](https://travis-ci.com/jedisct1/libsodium?branch=master)
2016-01-11 03:20:58 -07:00
[![Windows build status ](https://ci.appveyor.com/api/projects/status/fu8s2elx25il98hj?svg=true )](https://ci.appveyor.com/project/jedisct1/libsodium)
2019-01-30 10:45:53 -07:00
[![Coverity Scan Build Status ](https://scan.coverity.com/projects/2397/badge.svg )](https://scan.coverity.com/projects/2397)
2019-05-29 11:54:51 -07:00
[![Azure build status ](https://jedisct1.visualstudio.com/Libsodium/_apis/build/status/jedisct1.libsodium?branchName=stable )](https://jedisct1.visualstudio.com/Libsodium/_build/latest?definitionId=3& branchName=stable)
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,
2017-10-18 10:23:59 -07:00
including Windows (with MingW or Visual Studio, x86 and x64), iOS, Android,
as well as Javascript and Webassembly.
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
2020-05-04 16:28:48 -07:00
The documentation is available on Gitbook and built from the
[libsodium-doc ](https://github.com/jedisct1/libsodium-doc ) repository:
2014-05-08 14:19:46 -07:00
2020-04-02 14:09:34 -07:00
* [libsodium documentation ](https://doc.libsodium.org ) - online, requires Javascript.
2013-07-29 09:37:42 -07:00
2016-03-17 15:20:59 -07:00
## Integrity Checking
2016-03-17 15:26:02 -07:00
The integrity checking instructions (including the signing key for libsodium)
2018-11-06 09:40:11 -07:00
are available in the [installation ](https://download.libsodium.org/doc/installation#integrity-checking )
2016-03-17 15:27:08 -07:00
section of the documentation.
2016-03-17 15:20:59 -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
2019-07-15 06:46:53 -07:00
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute ](CONTRIBUTING.md )].
< a href = "https://github.com/jedisct1/libsodium/graphs/contributors" > < img src = "https://opencollective.com/libsodium/contributors.svg?width=890&button=false" / > < / a >
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute ](https://opencollective.com/libsodium/contribute )]
2020-05-04 16:28:48 -07:00
#### Individuals Href="https://opencollective.com/libsodium"><img src="https://opencollective.com/libsodium/individuals.svg?width=890"></a>
2019-07-15 06:46:53 -07:00
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute ](https://opencollective.com/libsodium/contribute )]
< a href = "https://opencollective.com/libsodium/organization/0/website" > < img src = "https://opencollective.com/libsodium/organization/0/avatar.svg" > < / a >
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 ).