package digestif
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=040f1558635c7fc49609406866ab1752e26ae4fcfae01f31d2dd902b5fbe696e
sha512=a3b904ed1b3e2354f5efd71ee546041d2bb31091161597acb82e4bc2d0686b34d348adba1aef5b927efa28e1764b60f65c171019dd11952c72a76c92510878ee
Description
Digestif is a toolbox to provide hashes implementations in C and OCaml.
It uses the linking trick and user can decide at the end to use the C implementation or the OCaml implementation.
We provides implementation of:
- MD5
- SHA1
- SHA224
- SHA256
- SHA384
- SHA512
- SHA3
- WHIRLPOOL
- BLAKE2B
- BLAKE2S
- RIPEMD160
Published: 10 Jul 2020
README
Digestif - Hash algorithms in C and OCaml
Digestif is a toolbox which implements hashes:
MD5
SHA1
SHA224
SHA256
SHA384
SHA512
WHIRLPOOL
BLAKE2B
BLAKE2S
RIPEMD160
Digestif uses a trick about linking and let the end-user to choose which implementation he wants to use. We provide 2 implementations:
C implementation with
digestif.c
OCaml implementation with
digestif.ocaml
Both are well-tested. However, OCaml implementation is slower than the C implementation.
Note: The linking trick requires digestif.c
or digestif.ocaml
to be the first of your dependencies.
Home page: http://din.osau.re/
Contact: Romain Calascibetta <romain.calascibet ta@gmail.com>
API
For each hash, we implement the same API which is referentially transparent. Then, on the top of these, we reflect functions (like digesti
or hmaci
) with GADT - however, conversion from GADT to hash type is not possible (but you can destruct GADT with to_raw_string
).
Equal/Compare function
We deciced to protect users to timing-attack. In this case, Digestif.equal
(by eqaf package) compares hashes in constant-time.
However, we provide unsafe_compare
function too which is not a constant time function. In some contexts, like ocaml-git
, we don't care about timing attack and we use unsafe_compare
- then, we need to make a wrap where we rename unsafe_compare
to compare
to be able to use it in some functors like Map.Make
or Set.Make
.
It's little annoying to do that but it forces the user to get the right question about security issues. So, please, don't ask to rename this function.
MirageOS
Of course, this package is available to be used on MirageOS (both implementations). User is able to compile digestif.ocaml
with js_of_ocaml
and this package is platform agnostic.
Build Requirements
OCaml >= 4.03.0 (may be less but need test)
base-bytes
meta-packagebase-bigarray
meta-packagedune
to build the project
If you want to compile the test program, you need:
alcotest
Credits
This work is from the nocrypto library and the Vincent hanquez's work in ocaml-sha.
All credits appear in the begin of files and this library is motivated by two reasons:
delete the dependancy with
nocrypto
if you don't use the encryption (and common) partaggregate all hashes functions in one library
Dependencies (6)
- stdlib-shims
- bigarray-compat
- base-bytes
- eqaf
-
dune
>= "2.6.0"
-
ocaml
>= "4.03.0"
Dev Dependencies (7)
Used by (40)
-
archetype
< "1.2.2"
-
aws
>= "1.2"
-
aws-s3
>= "4.2.0"
-
carton
< "0.4.4"
- dkim
-
dkim-mirage
>= "0.2.0"
-
docfd
>= "2.1.0"
-
dream
< "1.0.0~alpha3"
- dream-httpaf
-
git
>= "2.0.0" & < "3.9.1"
-
git-unix
>= "3.0.0" & < "3.9.1"
-
graphql-cohttp
>= "0.9.0"
-
index-bench
>= "1.5.0"
-
irmin
>= "2.0.0"
- irmin-cli
-
irmin-git
>= "2.0.0"
-
irmin-http
= "2.0.0" | >= "2.3.0"
- irmin-tezos
-
irmin-unix
>= "2.0.0"
-
jupyter-kernel
>= "0.4"
-
learn-ocaml
>= "0.12"
- learn-ocaml-client
- miou
-
naboris
>= "0.1.3"
- nocoiner
-
noise
>= "0.2.0"
- ocluster
- ocluster-worker
- octez-internal-libs
-
ometrics
>= "0.1.2"
-
owi
>= "0.2"
-
soupault
>= "4.4.0"
- spoke
- swhid_compute
- tezos-base58
-
tezos-context
< "11.0" | >= "12.0" & < "16.0"
- tezos-context-hash
- tezos-storage
-
tezos-store
< "12.0"
- zeit
Conflicts (2)
-
ocaml-freestanding
< "0.4.3"
-
mirage-xen-posix
< "3.1.0"