kazu-yamamoto/crypton
1
1
Fork 0
mirror of https://github.com/kazu-yamamoto/crypton.git synced 2024-10-06 00:37:20 +03:00
Code Issues Packages Projects Releases Wiki Activity
lowlevel set of cryptographic primitives for haskell
526 Commits 1 Branch 36 Tags 2.8 MiB
C 51.1%
Haskell 48.7%
Shell 0.2%
fba0565d78
Go to file
Phil Ruffwind fba0565d78 Document the arguments for DH.generateParams 
Also fix the formatting in the docs of Serialize.i2ospOf
2015-11-03 20:20:53 +08:00
benchs [bench] add some number for chacha poly1305 2015-07-30 14:40:54 +01:00
cbits Avoid endianess problems in integerify() 2015-08-27 14:52:03 +02:00
Crypto Document the arguments for DH.generateParams 2015-11-03 20:20:53 +08:00
gen [hash] add haddock documentation 2015-05-19 11:51:18 +01:00
tests [Curve25519] use the Crypto.Error api instead of an Either type for parsing types 2015-11-02 11:17:19 +00:00
.gitignore [bench] ignore binaries 2015-05-02 05:43:06 +01:00
.travis.yml remove multilines 2015-06-03 11:24:00 +01:00
CHANGELOG.md [Curve25519] use the Crypto.Error api instead of an Either type for parsing types 2015-11-02 11:17:19 +00:00
cryptonite.cabal [building] quiet down unused module imports 2015-11-02 11:16:48 +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 add BSD to support list 2015-07-08 13:46:42 +02: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 have specificities, that are hard to wrap in common APIs and types, so instead of trying to provide a common ground for algorithms that wouldn't allow to provide all different usage or a really complicated system, this just provide a non-consistant low-level API.

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

Documentation: cryptonite on hackage

Versioning

Development versions are an incremental number prefixed by 0. No specific meaning is associated with the versions, specially no API stability.

Production versions : TBD

Coding Style

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

Support

cryptonite supports the following platform:

  • 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 works too, but until maintainer(s) don't have regular access to them, we can't commit for 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 purpose), and one can do that 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