The sip-hash Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The sip-hash Reference Manual

This is the sip-hash Reference Manual, version 1.6, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:34:59 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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

http://131002.net/siphash/
https://github.com/veorq/SipHash

sip-hash API

sip-hash:hash-64-2-4 octets k0 k1 &key (start 0) 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.

sip-hash:hash-64-4-8 octets k0 k1 &key (start 0) 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.

sip-hash:hash-128-2-4 octets k0 k1 &key (start 0) 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.

sip-hash:hash-128-4-8 octets k0 k1 &key (start 0) 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.

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 sip-hash

Author

Robert Brown

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.6

Defsystem Dependency

com.google.base

Dependencies
Source

sip-hash.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 sip-hash.asd

Location

sip-hash.asd

Systems

sip-hash (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 sip-hash/package.lisp

Parent

sip-hash (system)

Location

package.lisp

Packages

sip-hash


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 sip-hash/sip-hash.lisp

Dependency

package.lisp (file)

Parent

sip-hash (system)

Location

sip-hash.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 sip-hash

An implementation of the SipHash family of hash functions.

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, sip-hash.asd: The sip-hash<dot>asd file
File, Lisp, sip-hash/package.lisp: The sip-hash/package<dot>lisp file
File, Lisp, sip-hash/sip-hash.lisp: The sip-hash/sip-hash<dot>lisp file

L
Lisp File, sip-hash.asd: The sip-hash<dot>asd file
Lisp File, sip-hash/package.lisp: The sip-hash/package<dot>lisp file
Lisp File, sip-hash/sip-hash.lisp: The sip-hash/sip-hash<dot>lisp file

S
sip-hash.asd: The sip-hash<dot>asd file
sip-hash/package.lisp: The sip-hash/package<dot>lisp file
sip-hash/sip-hash.lisp: The sip-hash/sip-hash<dot>lisp file

Jump to:   F   L   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   D   F   H   I   L   M   R   S   U  
Index Entry  Section

A
ash-u64: Internal macros

D
define-sip-hash: Internal macros

F
Function, hash-128-2-4: Exported functions
Function, hash-128-4-8: Exported functions
Function, hash-64-2-4: Exported functions
Function, hash-64-4-8: Exported functions
Function, rotate-left-64: Internal functions

H
hash-128-2-4: Exported functions
hash-128-4-8: Exported functions
hash-64-2-4: Exported functions
hash-64-4-8: Exported functions

I
incf64: Internal macros

L
logiorf: Internal macros
logxorf: Internal macros

M
Macro, ash-u64: Internal macros
Macro, define-sip-hash: Internal macros
Macro, incf64: Internal macros
Macro, logiorf: Internal macros
Macro, logxorf: Internal macros
Macro, mod-2^64: Internal macros
Macro, rotatef-left-64: Internal macros
Macro, sip-round: Internal macros
Macro, u64+: Internal macros
mod-2^64: Internal macros

R
rotate-left-64: Internal functions
rotatef-left-64: Internal macros

S
sip-round: Internal macros

U
u64+: Internal macros

Jump to:   A   D   F   H   I   L   M   R   S   U  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, sip-hash: The sip-hash package

S
sip-hash: The sip-hash system
sip-hash: The sip-hash package
System, sip-hash: The sip-hash system

Jump to:   P   S