Module documentation for 0.1.1.1
A Haskell binding for @jedisct1’s portable binding for djb’s NaCl. This is an early release. Please try it out, but don’t just yet stake your life or job on it.
It is imperative you call
sodiumInit before using any other function.
import Crypto.Saltine import Crypto.Saltine.Core.SecretBox import qualified Data.ByteString.Char8 as BSC8 main = do sodiumInit k <- newKey n <- newNonce let ciphertext = secretbox k n (BSC8.pack "foobar") print $ secretboxOpen k n ciphertext -- Just "foobar"
In The Security Impact of a New Cryptographic Library Bernstein, Lange, and Schwabe argue that high-level cryptographic libraries eliminate whole spaces of cryptographic disasters which are nigh inevitable whenever programmers use low-level crypto primitives.
- Security Stack Exchange: Why Shouldn’t We Roll Our Own?
- Hacker News on “All the Crypto Code You’ve Ever Written is Probably Broken”
- Stack Overflow: When can you trust yourself to implement cryptography based solutions?
- Coding Horror: Why isn’t my encryption… encrypting?
Crypto is complicated, so pre-rolled solutions are important prevention mechanisms.
NaCl is Bernstein, Lange, and Schwabe’s
solution: a high-level, performant cryptography library with a no-fuss
interface. Saltine is a Haskell
binding to NaCl (via
libsodium) which hopes to
provide even more simplicity and safety to the usage of cryptography.
Note that it’s still possible to shoot yourself in the foot pretty
easily using Saltine. Nonces must always be unique which must be managed
by the library user.
produces messages which can beundetectably tampered with in-flight.
Keys are insecurely read from disk—they may be copied and then paged
back to disk.
To use it on Windows systems, download
a prebuild libsodium-*-stable-mingw.tar.gz file
and copy the files in
libsodium-win64 into the equivalent places
C:\Program Files\Haskell Platform\*\mingw. Then just add saltine
to your cabal file and watch it go.
Inspired by @thoughtpolice’s
binds to NaCl, but uses a Haskell managed version of djb’s code
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
[0.1.1.1] - 2021-01-15
- Fix for running tests in
cabal repl(thanks [@timds])
- Allow newer profunctors
[0.1.1.0] - 2020-02-29
- bindings to generichash (Blake2), thanks @donatello
- Don’t use
failin tests to fix compilation with GHC 8.8
- Windows install instructions added, thanks @tmcl