diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 48 |
1 files changed, 47 insertions, 1 deletions
@@ -1,4 +1,50 @@ SipHash ======= -Reference implementation of SipHash +Reference implementation of SipHash, a family of pseudorandom functions +optimized for speed on short messages. + +SipHash was designed as a mitigation to [hash-flooding DoS +attacks](https://131002.net/siphash/siphashdos_29c3_slides.pdf). +It is now used in the hash tables implementation of Python, Ruby, Perl +5, etc. + +SipHash was designed by [Jean-Philippe Aumasson](https://131002.net) and +[Daniel J. Bernstein](http://cr.yp.to). + + +Usage +----- + +Running + +```sh + $ make +``` + +will compile and run sanity checks (test vectors) for SipHash-2-4, the +default version of SipHash. + +The code can be adapted to implement SipHash-*c*-*d*, the version of SipHash +with *c* compression rounds and *d* finalization rounds, by tweaking the +lines +```C +#define cROUNDS 2 +#define dROUNDS 4 +``` + + +License +------- + +The SipHash reference code is released under [CC0 license](https://creativecommons.org/publicdomain/zero/1.0/), a public +domain-like licence. + + +References +---------- + +The [SipHash page](https://131002.net/siphash) includes +* a list of third-party implementations and modules +* a list of projects using SipHash +* references to cryptanalysis results |