hash

Documentation

Index

• Variables
• type Argon2
  • func NewHasherArgon2(c Argon2Configuration) *Argon2
  • func (h *Argon2) Compare(password []byte, hash []byte) error
  • func (h *Argon2) Generate(password []byte) ([]byte, error)
• type Argon2Configuration
• type HashProvider
• type Hasher

Variables

var (
	ErrInvalidHash               = errors.New("the encoded hash is not in the correct format")
	ErrIncompatibleVersion       = errors.New("incompatible version of argon2")
	ErrMismatchedHashAndPassword = errors.New("passwords do not match")
)

Types

type Argon2

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

func NewHasherArgon2

func NewHasherArgon2(c Argon2Configuration) *Argon2

func (*Argon2) Compare

func (h *Argon2) Compare(password []byte, hash []byte) error

func (*Argon2) Generate

func (h *Argon2) Generate(password []byte) ([]byte, error)

type Argon2Configuration

type Argon2Configuration interface {
	HasherArgon2() *configuration.HasherArgon2Config
}

type HashProvider

type HashProvider interface {
	Hasher() Hasher
}

type Hasher

type Hasher interface {
	// Compare a password to a hash and return nil if they match or an error otherwise.
	Compare(password []byte, hash []byte) error

	// Generate returns a hash derived from the password or an error if the hash method failed.
	Generate(password []byte) ([]byte, error)
}

Hasher provides methods for generating and comparing password hashes.