kazu-yamamoto/crypton
1
1
Fork 0
mirror of https://github.com/kazu-yamamoto/crypton.git synced 2024-10-05 16:27:35 +03:00
Code Issues Packages Projects Releases Wiki Activity
lowlevel set of cryptographic primitives for haskell
618 Commits 1 Branch 36 Tags 2.8 MiB
C 51.1%
Haskell 48.7%
Shell 0.2%
ed31cf7549
Go to file
Vincent Hanquez ed31cf7549 Merge pull request #87 from dredozubov/typo-fix 
Improve some documentation phrasing and fix typos.
2016-05-06 06:05:20 +01:00
benchs [bench] add some number for chacha poly1305 2015-07-30 14:40:54 +01:00
cbits [Curve25519] Enabled 64-bit implementation 2016-04-20 11:23:51 -07:00
Crypto fix documentation typo 2016-05-05 19:51:22 +03:00
gen Improve context memory usage of Keccak and SHA3 2016-03-26 10:29:33 +00:00
tests [Ed448] Fixed incorrect base point 2016-04-18 13:25:11 -07:00
.gitignore [bench] ignore binaries 2015-05-02 05:43:06 +01:00
.travis.yml update .travis 2016-01-14 19:17:43 +00:00
CHANGELOG.md [Curve25519] Enabled 64-bit implementation 2016-04-20 11:23:51 -07:00
cryptonite.cabal Decoupled -DARCH_X86_64 and support_rdrand 2016-04-21 10:45:23 -07: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 Minor grammatical updates 2016-04-21 10:40:09 -07:00
Setup.hs initial commit. 2014-07-04 14:58:01 +01:00

README.md

cryptonite

Join the chat at https://gitter.im/vincenthz/cryptonite Build Status BSD Haskell

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

Links

TODO

  • add support for XSalsa