hashtools

Documentation

Index

• Variables
• func AsMap() map[string]*HashTool
• func New(name string) (hash.Hash, error)
• func Register(hashTool *HashTool)
• type HashTool
  • func AsList() []*HashTool
  • func Get(name string) (*HashTool, error)
  • func (ht *HashTool) LabeledHasher() lhash.Algorithm
  • func (ht *HashTool) New() hash.Hash
  • func (ht *HashTool) With(changes *HashTool) *HashTool

Variables

var (

	// ErrNotFound is returned when a hash tool cannot be found.
	ErrNotFound = errors.New("does not exist")
)

Functions

func AsMap

func AsMap() map[string]*HashTool

AsMap returns all HashTools in a map. The returned map must not be modified.

func New

func New(name string) (hash.Hash, error)

New returns a new hash.Hash with the given name.

func Register

func Register(hashTool *HashTool)

Register registers a new HashTool. This function may only be called in init() functions.

Types

type HashTool

type HashTool struct {
	Name string

	NewHash      func() hash.Hash
	CryptoHashID crypto.Hash

	DigestSize    int // in bytes
	BlockSize     int // in bytes
	SecurityLevel int // approx. attack complexity as 2^n

	Comment string
	Author  string
	// contains filtered or unexported fields
}

HashTool holds generic information about a hash tool.

func AsList

func AsList() []*HashTool

AsList returns all HashTools in a slice. The returned slice must not be modified.

func Get

func Get(name string) (*HashTool, error)

Get returns the HashTool with the given name.

func (*HashTool) LabeledHasher

func (ht *HashTool) LabeledHasher() lhash.Algorithm

LabeledHasher returns the corresponding labeled hashing algorithm.

func (*HashTool) New

func (ht *HashTool) New() hash.Hash

New returns a new hash.Hash instance of the hash tool.

func (*HashTool) With

func (ht *HashTool) With(changes *HashTool) *HashTool

With uses the original HashTool as a template for a new HashTool and returns the new HashTool.