Skip to content
David Herrmann edited this page Dec 15, 2017 · 2 revisions

The c-siphash project is a standalone implementation of SipHash in Standard ISO-C11. It provides a streaming-capable API to compute data hashes according to the SipHash algorithm. The SipHash code is based on the reference implementation (written by Jean-Philippe Aumasson and Daniel J. Bernstein, and release to the Public Domain).

Available Packages

  • none

Using c-siphash

The c-siphash project mainly consists of a single C-library. There are two ways to make use of it:

  • Static Linking: The preferred way of using c-siphash is to link it statically into your projects. The easiest solution is to include it as git-submodule and integrate it as meson-subproject. If that is not an option, you can simply copy the header and source files and compile them manually. No special precautions necessary.

  • Dynamic Linking: If you install the c-siphash library, it will come with a pkg-config file for convenient linking. The c-siphash.h header is install into the requested include directory, and the libcsiphash.so library is intalled into the requested library directory.

Documentation

The API documentation can be found as docbook-style comments in the source. The entry-point is c-siphash.h, with each function definition including a docbook-style function documentation. There is no rendered version available right now.

Clone this wiki locally