phash

package

v0.0.0-...-c2fed7e Latest Latest Go to latest Published: Aug 22, 2021 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrInvalidAlgo = errors.New("invalid algorithm was used to verify this password")

View Source

var ErrMalformedHash = errors.New("encoded password hash is malformed and can't be decoded")

View Source

var ErrPasswordInvalid = errors.New("password does not match hash given")

This section is empty.

type Argon2IDPasswordHasher struct {
	AlgoID  []byte
	SaltRNG io.Reader
	Options Argon2Options // needs to be set, defaults are not valid options
}

func (h *Argon2IDPasswordHasher) HashPassword(password []byte) (hash PasswordHash, err error)

func (h *Argon2IDPasswordHasher) ValidatePassword(password []byte, hash PasswordHash) (err error)

type Argon2Options struct {
	Time    uint32
	Memory  uint32
	Threads uint8
	KeyLen  uint32

	SaltLen uint32 // if zero then salt is omited
}

type PasswordHash struct {
	RawHash []byte
	Salt    []byte
	AlgoID  []byte
}

func (h *PasswordHash) Decode(buf []byte) (err error)

Decode decodes encoded PasswordHash into structure, which has this method called on. Removes any previous data.

func (h *PasswordHash) Encode(buf []byte) ([]byte, error)

type PasswordHasher interface {
	HashPassword(password []byte) (hash PasswordHash, err error)
}

type PasswordVerifier interface {
	ValidatePassword(password []byte, hash PasswordHash) (err error)
}