@hackage cryptonite0.30

Cryptography Primitives sink

cryptonite

[Join the chat at https://gitter.im/vincenthz/cryptonite](https://badges.gitter.im/Join%20Chat.svg) 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

Stability

Cryptonite APIs are stable, and we only strive to add, not change or remove. Note that because the API exposed is wide and also expose internals things (for power users and flexibility), certains APIs can be revised in extreme cases where we can't just add.

Versioning

Next version of 0.x is 0.(x+1). There's no exceptions, or API related meaning behind the numbers.

Each versions of stackage (going back 3 stable LTS) has a cryptonite version that we maintain with security fixes when necessary and are versioned with the following 0.x.y scheme.

Coding Style

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

Support

See Haskell packages guidelines

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

On CentOS 7 the default C compiler includes intrinsic header files incompatible with per-function target options. Solutions are to use GCC >= 4.9 or disable flag use_target_attributes (see flag configuration examples below).

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

Enabling PCLMULDQ

When the C toolchain supports it, enabling flag support_pclmuldq can bring additional security and performance for AES GCM. A CPU with the necessary instruction set will use an alternate implementation selected at runtime.

  • Installation

  • Tested Compilers

  • Dependencies (8)

  • Dependents (244)

    @hackage/hopenpgp-tools, @hackage/wrecker, @hackage/signify-hs, @hackage/cachix-api, @hackage/backblaze-b2-hs, @cardano/cardano-node-socket-emulator, Show all…

    • Package Flags

      support_aesni
       (on by default)

      allow compilation with AESNI on system and architecture that supports it

      support_rdrand
       (on by default)

      allow compilation with RDRAND on system and architecture that supports it

      support_pclmuldq
       (off by default)

      Allow compilation with pclmuldq on architecture that supports it

      support_sse
       (off by default)

      Use SSE optimized version of (BLAKE2, ARGON2)

      integer-gmp
       (on by default)

      Whether or not to use GMP for some functions

      support_deepseq
       (on by default)

      add deepseq instances for cryptographic types

      old_toolchain_inliner
       (off by default)

      use -fgnu89-inline to workaround an old compiler linker glibc issue.

      check_alignment
       (off by default)

      extra check on alignment in C layers, which cause lowlevel assert errors. for debugging only.

      use_target_attributes
       (on by default)

      use GCC / clang function attributes instead of global target options.