h2hash

Documentation

Index

• Variables
• func KeyID(params string) string
• type Algs
• type AlgsMap
  • func NewAlgsMap() *AlgsMap
  • func (m *AlgsMap) Get(id string) (Builder, bool)
  • func (m *AlgsMap) Register(b Builder)
• type Builder
• type Hasher
  • func FromParams(params string, algs Algs) (Hasher, error)
• type Verifier
  • func NewVerifier() *Verifier
  • func (v *Verifier) Register(hasher Hasher)
  • func (v *Verifier) Verify(msg []byte, msghash string) (bool, error)

Variables

var (
	// ErrNotSupported is returned when the hash is unsupported
	ErrNotSupported errNotSupported
	// ErrInvalidFormat is returned when the hash format is invalid
	ErrInvalidFormat errInvalidFormat
	// ErrKeyInvalid is returned when the hash key config is invalid
	ErrKeyInvalid errKeyInvalid
)

Functions

func KeyID

func KeyID(params string) string

KeyID computes a key id from params

Types

type Algs

type Algs interface {
	Register(b Builder)
	Get(id string) (Builder, bool)
}

Algs are a map of valid hash algorithms

type AlgsMap

type AlgsMap struct {
	// contains filtered or unexported fields
}

func NewAlgsMap

func NewAlgsMap() *AlgsMap

func (*AlgsMap) Get

func (m *AlgsMap) Get(id string) (Builder, bool)

func (*AlgsMap) Register

func (m *AlgsMap) Register(b Builder)

type Builder

type Builder interface {
	ID() string
	Build(params string) (Hasher, error)
}

Builder constructs a new hasher from params

type Hasher

type Hasher interface {
	ID() string
	Hash(msg []byte) (string, error)
	Verify(msg []byte, msghash string) (bool, error)
}

Hasher is a hash interface

func FromParams

func FromParams(params string, algs Algs) (Hasher, error)

FromParams creates a hasher from params

type Verifier

type Verifier struct {
	// contains filtered or unexported fields
}

Verifier verifies hashes

func NewVerifier

func NewVerifier() *Verifier

func (*Verifier) Register

func (v *Verifier) Register(hasher Hasher)

Register registers a Hasher

func (*Verifier) Verify

func (v *Verifier) Verify(msg []byte, msghash string) (bool, error)

Verify checks to see if the hash of the given msg matches the provided msghash