package digestif
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=9bc36ff76944792d39e90f7feaf5a2f86b047396d4b707937f4c60b0dcb9bb80
md5=9d9f23d49da275d13a651c5294001227
README.md.html
Digestif - Hash algorithms in OCaml
Digestif (and Rakia) provided some hashes functions in OCaml. Rakia provided theses functions by a C stub and Digestif is a pure implementation in OCaml of theses hashes. So theses hashes functions can be used in an OCaml/Mirage/JavasScript world.
Obviously, Rakia is more faster than Digestif (the hot loop was implemented in C) but it's possible than Rakia can't compile in your architecture. In this case, it's better to use Digestif or send a PR to fix Rakia.
API
We provided an interface with no dependancy (only with Bigarray
, available by the OCaml distribution). You can choose between the Bytes
module or the Bigstring
module. You can't remove the dependancy with Bigarray
because the context of the hash function is internally a Bigstring.t
.
We provided the same interface:
val init : unit -> ctx
val feed : ctx -> buffer -> unit
val get : ctx -> buffer
val digest : buffer -> buffer
val digestv : buffer list -> buffer
val hmac : key:buffer -> buffer -> buffer
val hmacv : key:buffer -> buffer list -> buffer
buffer
can be a Bytes.t
or a Bigstring.t
. We have an imperative and a functionnal way to produce a hash.
Hashes functions
At this time, we implement these hashes:
SHA1
SHA224
SHA256
SHA384
SHA512
BLAKE2B
If you want an other hash function, you can ask in the issue.
Build Requirements
OCaml >= 4.03.0 (may be less but need test)
base-bytes
meta-packageBigarray module (provided by the standard library of OCaml)
topkg
,ocamlbuild
andocamlfind
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
We deleted the cstruct
hard dependancy (from nocrypto
) and provide a interface to compute with the Bytes.t
. We add the blake2b
implementation too and we have the plan to provide the hash function in pure OCaml and other hashes functions. Finally, you can use nocrypto
and digestif
together (no clash name in the C stub, don't worry).
So, yes, it's redundant but deal with it!