Go to file

Luke Taylor 28ce4ddde6 Remove byteable dependency from test suite This no longer seems to be used and is liable to make people think that cryponite provides Byteable instances when in fact its use is deprecated.		2017-01-01 17:20:20 +00:00
benchs	Removed redundant imports	2016-09-10 12:08:34 +02:00
cbits	process unaligned data through a trampoline buffer when architecture needs it	2016-12-09 15:04:02 +00:00
Crypto	Merge pull request #118 from tmciver/master	2016-12-09 10:59:17 +00:00
gen	Improve context memory usage of Keccak and SHA3	2016-03-26 10:29:33 +00:00
tests	Implement the XSalsa20 stream cipher	2016-10-09 15:25:31 +02:00
.gitignore	Add .stack-work to .gitignore	2016-07-27 17:45:37 +02:00
.travis.yml	Drop test support for GHC 7.0, GHC 7.4 and GHC 7.6.	2016-12-17 10:37:16 +00:00
CHANGELOG.md	missing entry	2016-12-18 06:50:29 +00:00
CONTRIBUTING.md	add CONTRIBUTING guide - non definitive	2016-12-09 15:06:05 +00:00
cryptonite.cabal	Remove byteable dependency from test suite	2017-01-01 17:20:20 +00:00
cryptonite.sublime-project	wip	2015-04-08 14:12:58 +01:00
LICENSE	update main license	2015-03-12 05:44:23 +00:00
Makefile	add dummy makefile to run QA	2015-05-03 14:26:21 +01:00
QA.hs	[QA] update to latest state of things	2015-07-29 10:02:44 +01:00
README.md	Implement the XSalsa20 stream cipher	2016-10-09 15:25:31 +02:00
Setup.hs	initial commit.	2014-07-04 14:58:01 +01:00

README.md

cryptonite

Cryptonite is a haskell repository of cryptographic primitives. Each crypto algorithm has specificities that are hard to wrap in common APIs and types, so instead of trying to provide a common ground for algorithms, this package provides a non-consistent low-level API.

If you have no idea what you're doing, please do not use this directly. Instead, rely on higher level protocols or implementations.

Documentation: cryptonite on hackage

Versioning

Development versions are an incremental number prefixed by 0. There is no API stability between development versions.

Production versions : TBD

Coding Style

The coding style of this project mostly follows: haskell-style

Support

cryptonite supports the following platforms:

Windows >= 8
OSX >= 10.8
Linux
BSDs

On the following architectures:

x86-64
i386

On the following haskell versions:

GHC 7.0.x
GHC 7.4.x
GHC 7.6.x
GHC 7.8.x
GHC 7.10.x

Further platforms and architectures probably work too, but since the maintainer(s) don't have regular access to them, we can't commit to further support.

Known Building Issues

On OSX <= 10.7, the system compiler doesn't understand the '-maes' option, and with the lack of autodetection feature builtin in .cabal file, it is left on the user to disable the aesni. See the [Disabling AESNI] section

Disabling AESNI

It may be useful to disable AESNI for building, testing or runtime purposes. This is achieved with the support_aesni flag.

As part of configure of cryptonite:

  cabal configure --flag='-support_aesni'

or as part of an installation:

  cabal install --constraint="cryptonite -support_aesni"

For help with cabal flags, see: stackoverflow : is there a way to define flags for cabal