diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 14 insertions, 33 deletions
@@ -1,5 +1,4 @@ -SipHash -======= +# SipHash Reference implementation of SipHash, a family of pseudorandom functions optimized for speed on short messages. @@ -13,8 +12,7 @@ SipHash was designed by [Jean-Philippe Aumasson](https://131002.net) and [Daniel J. Bernstein](http://cr.yp.to). -Usage ------ +## Usage Running @@ -22,17 +20,23 @@ Running make ``` -will build sanity checks (test vectors) for SipHash-2-4, the default -version of SipHash: +will build tests for + +* SipHash-2-4, the default version of SipHash returning 64-bit tags +* SipHash-2-4 with doubled tag size, i.e. 128-bit tags +* HalfSipHash-2-4, a version of SipHash working with 32-bit words and + returning 32-bit tags by default +* HalfSipHash-2-4 with doubled tag size, i.e. 64-bit tags + ```C - ./siphash24_test + ./test ``` verifies 64 test vectors, and ```C - ./siphash24_debug + ./debug ``` does the same and prints intermediate values. @@ -49,30 +53,8 @@ Obviously, if the number of rounds is modified then the test vectors won't verify. -128-bit tags (experimental) ---------------------------- - -In addition to the original SipHash, which returns 64-bit tags, this -reference code implements an experimental mode to return 128-bit tags. -This mode is enabled when the constant `DOUBLE` is defined. - -Running - -```sh - make double -``` - -will build `siphash24_test_double` and `siphash24_debug_double`. - -SipHash with 128-bit tags targets PRF security with 128-bit key and -128-bit tags. In particular, any attack trying up to 2^s should -succeed with probability at most 2^(s - 128). - -The **128-bit mode is experimental**, use at your own risk. - -Intellectual property ---------------------- +## Intellectual property The SipHash reference code is released under [CC0 license](https://creativecommons.org/publicdomain/zero/1.0/), a public @@ -82,8 +64,7 @@ We aren't aware of any patents or patent applications relevant to SipHash, and we aren't planning to apply for any. -References ----------- +## References The [SipHash page](https://131002.net/siphash) includes * a list of third-party implementations and modules |