The sip-hash Reference Manual

Table of Contents

The sip-hash Reference Manual

This is the sip-hash Reference Manual, version 1.7, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:48:03 2021 GMT+0.

1 Introduction

sip-hash

A Common Lisp implementation of SipHash, a cryptographically strong family of hash functions designed by Jean-Philippe Aumasson and Daniel J. Bernstein.

For more information see the SipHash web site and the SipHash reference implementation.

The sip-hash API

hash-64-2-4 octets k0 k1 &key (start 0) (end (length octets))

Returns as an (unsigned-byte 64) the 64-bit SipHash-2-4 hash code for
positions START through END of OCTETS, using the initial state stored in K0
and K1.

hash-64-4-8 octets k0 k1 &key (start 0) (end (length octets))

Returns as an (unsigned-byte 64) the 64-bit SipHash-4-8 hash code for
positions START through END of OCTETS, using the initial state stored in K0
and K1.

hash-128-2-4 octets k0 k1 &key (start 0) (end (length octets))

Returns as two (unsigned-byte 64) values the 128-bit SipHash-2-4 hash code
for positions START through END of OCTETS, using the initial state stored
in K0 and K1.

hash-128-4-8 octets k0 k1 &key (start 0) (end (length octets))

Returns as two (unsigned-byte 64) values the 128-bit SipHash-4-8 hash code
for positions START through END of OCTETS, using the initial state stored
in K0 and K1.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 sip-hash

Author

Robert Brown <robert.brown@gmail.com>

License

Public domain

Description

SipHash hash functions

Long Description

SipHash, a cryptographically strong family of hash functions designed by Jean-Philippe Aumasson and Daniel J. Bernstein. (http://131002.net/siphash/)

Version

1.7

Defsystem Dependency

com.google.base

Dependencies

• com.google.base
• nibbles
• sb-rotate-byte

Source

sip-hash.asd (file)

Components

• package.lisp (file)
• sip-hash.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 sip-hash.asd

Location

sip-hash.asd

Systems

sip-hash (system)

3.1.2 sip-hash/package.lisp

Parent

sip-hash (system)

Location

package.lisp

Packages

sip-hash

3.1.3 sip-hash/sip-hash.lisp

Dependency

package.lisp (file)

Parent

sip-hash (system)

Location

sip-hash.lisp

Exported Definitions

• hash-128-2-4 (function)
• hash-128-4-8 (function)
• hash-64-2-4 (function)
• hash-64-4-8 (function)

Internal Definitions

• ash-u64 (macro)
• define-sip-hash (macro)
• incf64 (macro)
• logiorf (macro)
• logxorf (macro)
• mod-2^64 (macro)
• rotate-left-64 (function)
• rotatef-left-64 (macro)
• sip-round (macro)
• u64+ (macro)

4 Packages

Packages are listed by definition order.

4.1 sip-hash

An implementation of the SipHash family of hash functions.

Source

package.lisp (file)

Use List

• com.google.base
• common-lisp

Exported Definitions

• hash-128-2-4 (function)
• hash-128-4-8 (function)
• hash-64-2-4 (function)
• hash-64-4-8 (function)

Internal Definitions

• ash-u64 (macro)
• define-sip-hash (macro)
• incf64 (macro)
• logiorf (macro)
• logxorf (macro)
• mod-2^64 (macro)
• rotate-left-64 (function)
• rotatef-left-64 (macro)
• sip-round (macro)
• u64+ (macro)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: hash-128-2-4 OCTETS K0 K1 &key START END

Returns as two (unsigned-byte 64) values the 128-bit SipHash-2-4 hash code for positions START through END of OCTETS, using the initial state stored in K0 and K1.

Package

sip-hash

Source

sip-hash.lisp (file)

Function: hash-128-4-8 OCTETS K0 K1 &key START END

Returns as two (unsigned-byte 64) values the 128-bit SipHash-4-8 hash code for positions START through END of OCTETS, using the initial state stored in K0 and K1.

Package

sip-hash

Source

sip-hash.lisp (file)

Function: hash-64-2-4 OCTETS K0 K1 &key START END

Returns as an (unsigned-byte 64) the 64-bit SipHash-2-4 hash code for positions START through END of OCTETS, using the initial state stored in K0 and K1.

Package

sip-hash

Source

sip-hash.lisp (file)

Function: hash-64-4-8 OCTETS K0 K1 &key START END

Returns as an (unsigned-byte 64) the 64-bit SipHash-4-8 hash code for positions START through END of OCTETS, using the initial state stored in K0 and K1.

Package

sip-hash

Source

sip-hash.lisp (file)

5.2 Internal definitions

5.2.1 Macros

Macro: ash-u64 X Y

Package

sip-hash

Source

sip-hash.lisp (file)

Macro: define-sip-hash FUNCTION-NAME COMPRESS-ROUNDS FINALIZATION-ROUNDS DOUBLE DOCUMENTATION

Defines a function called FUNCTION-NAME that implements the SipHash hash function that performs COMPRESS-ROUNDS compression rounds and FINALIZATION-ROUNDS finalization rounds. The defined SipHash function is documented with a DOCUMENTATION string. When DOUBLE is true, a 128-bit hash result is produced.

Package

sip-hash

Source

sip-hash.lisp (file)

Macro: incf64 PLACE X

Increment, modulo 2^64, PLACE by X.

Package

sip-hash

Source

sip-hash.lisp (file)

Macro: logiorf PLACE X

Logically inclusive or PLACE by X.

Package

sip-hash

Source

sip-hash.lisp (file)

Macro: logxorf PLACE X

Logically exclusive or PLACE by X.

Package

sip-hash

Source

sip-hash.lisp (file)

Macro: mod-2^64 X

Package

sip-hash

Source

sip-hash.lisp (file)

Macro: rotatef-left-64 PLACE X

Rotate 64-bit PLACE left by X bit positions.

Package

sip-hash

Source

sip-hash.lisp (file)

Macro: sip-round V0 V1 V2 V3

Package

sip-hash

Source

sip-hash.lisp (file)

Macro: u64+ X Y

Package

sip-hash

Source

sip-hash.lisp (file)

5.2.2 Functions

Function: rotate-left-64 X COUNT

Rotates the unsigned 64-bit integer X left by COUNT bit positions.

Package

sip-hash

Source

sip-hash.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types