SipHash-2-4的Go语言实现使用说明

本文档将详细介绍如何使用Go语言实现的SipHash-2-4哈希算法库。内容包括安装指南、使用说明以及API使用文档。

1. 安装指南

要安装SipHash-2-4的Go语言实现，请运行以下命令：

go get github.com/dchest/siphash

此命令会将SipHash-2-4的Go实现安装到您的Go工作空间中。

2. 项目使用说明

SipHash-2-4是一种快速的短输入伪随机函数（PRF），本项目为其Go语言实现。以下是使用该项目的两种方式：

• 使用hash.Hash64接口：这种方式相对较慢，需要创建一个哈希对象，并写入数据，然后计算摘要。

  import "github.com/dchest/siphash"
  
  h := siphash.New(key)
  h.Write([]byte("Hello"))
  sum := h.Sum(nil) // 返回8字节的[]byte
  

  或者，

  sum64 := h.Sum64() // 返回uint64
  

• 使用Hash()函数：这种方式更快，直接接收两个uint64类型的16字节密钥和一个字节切片，并返回一个uint64哈希值。

  sum64 := siphash.Hash(key0, key1, []byte("Hello"))
  

请注意，密钥和输出均使用小端字节序。

3. 项目API使用文档

以下是本项目提供的API文档：

func Hash(k0, k1 uint64, p []byte) uint64

Hash函数根据提供的16字节密钥的两个64位部分和字节切片计算并返回64位的SipHash-2-4哈希值。

func Hash128(k0, k1 uint64, p []byte) (uint64, uint64)

Hash128函数根据提供的16字节密钥的两个64位部分和字节切片计算并返回128位的SipHash-2-4哈希值。请注意，128位SipHash目前被认为是不稳定的。

func New(key []byte) hash.Hash64

New函数返回一个使用16字节密钥计算SipHash-2-4的新hash.Hash64对象。

func New128(key []byte) hash.Hash

New128函数返回一个使用16字节密钥和16字节输出计算SipHash-2-4的新hash.Hash对象。请注意，16字节输出目前被认为是不稳定的。

4. 项目安装方式

项目的安装方式已在安装指南部分进行了说明，您可以通过运行go get github.com/dchest/siphash命令来安装该库。

以上为SipHash-2-4的Go语言实现项目的使用与安装说明，希望对您有所帮助。