auth

Documentation

Index

• Variables
• type AuthStore
• type Authenticator
  • func New(store AuthStore) Authenticator
  • func (a Authenticator) Authenticate(username, password string) error
• type PasswordHash
  • func HashPassword(plaintext string) (PasswordHash, error)
  • func PasswordHashFromBytes(bytes []byte) PasswordHash

Variables

var (
	ErrUserNotFound      = errors.New("user not found")
	ErrIncorrectPassword = errors.New("password does not match stored hash")
)

Types

type AuthStore

type AuthStore interface {
	ReadPasswordHash(username string) (PasswordHash, error)
}

type Authenticator

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

func New

func New(store AuthStore) Authenticator

func (Authenticator) Authenticate

func (a Authenticator) Authenticate(username, password string) error

type PasswordHash

type PasswordHash interface {
	MatchesPlaintext(string) bool
	Bytes() []byte
}

func HashPassword

func HashPassword(plaintext string) (PasswordHash, error)

Hash a plaintext password into a secure password hash.

func PasswordHashFromBytes

func PasswordHashFromBytes(bytes []byte) PasswordHash

Converts raw bytes into a password hash. Note that this doesn't perform a hash on the bytes. The bytes represent an already-hashed password.