pwhash

type Argon2Options ¶

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

Argon2Options represents Argon2 specific options.

type HashVersion ¶

type HashVersion = uint64

HashVersion is hasher identifier used for hash versioning.

type HashVersionMismatchError ¶

type HashVersionMismatchError struct {
	CurrentVersion HashVersion
	GivenVersion   HashVersion
}

HashVersionMismatchError is returned when PWHash version does not match one in hash.

func (e *HashVersionMismatchError) Error() string

type Hasher ¶

type Hasher = func(password []byte) (hash PWHash, err error)

Hasher is function-based hasher, which is able to hash passwords.

type NoVerifierMatchedError ¶

type NoVerifierMatchedError struct {
	Version HashVersion
}

NoVerifierMatchedError is returned, when no verifier could be matched in given VerifierChain.

func (e *NoVerifierMatchedError) Error() string

type Options ¶

type Options struct {
	HashVersion HashVersion

	SaltSize int
	SaltRNG  rand.RNG

	// Like salt, but stored outside DB and same for all users.
	// It's prepended to each password.
	// It should be long enough not to be brute-forceable.
	Pepper []byte
}

type PWHash ¶

type PWHash struct {
	Version uint64 `json:"version,omitempty"`
	Hash    []byte `json:"hash"`
	Salt    []byte `json:"salt"`
}

PWHash represents password hash with additonal options, useful for password hashing.

func (h *PWHash) DecodeBytes(bb []byte) (err error)

func (h *PWHash) DecodeString(bb string) (err error)

func (h *PWHash) EncodeToBytes() (dst []byte, err error)

func (h *PWHash) EncodeToString() (res string, err error)

type PWHashDecodeError ¶

type PWHashDecodeError struct {
	Err error
}

func (err *PWHashDecodeError) Error() string

func (err *PWHashDecodeError) Unwrap() error

type Verifier ¶

type Verifier = func(password []byte, hash PWHash) (equal bool, err error)

Verifier verifies hashes produced by PasswordHasher.

func VerifierChain(
	verifiers ...Verifier,
) Verifier