hash

Documentation

Overview

Package hash implments the Noise Protocol Framework hash function abstract interface and standard hash functions.

Index

• func Register(hash Hash)
• type Hash
  • func FromString(s string) Hash

Functions

func Register

func Register(hash Hash)

Register registers a new hash algorithm for use with `FromString()`.

Types

type Hash

type Hash interface {
	fmt.Stringer

	// New constructs a new `hash.Hash` instance.
	New() hash.Hash

	// Size returns the hash function's digest size in bytes (`HASHLEN`).
	Size() int
}

Hash is a collision-resistant cryptographic hash function factory.

var (
	// SHA256 is the SHA256 hash function.
	SHA256 Hash = &hashSha256{}

	// SHA512 is the SHA512 hash function.
	SHA512 Hash = &hashSha512{}

	// BLAKE2s is the BLAKE2s hash function.
	BLAKE2s Hash = &hashBlake2s{}

	// BLAKE2b is the BLAKE2b hash function.
	BLAKE2b Hash = &hashBlake2b{}
)

func FromString

func FromString(s string) Hash

FromString returns a Hash by algorithm name, or nil.