hash

Documentation

Index

• Variables
• func Compare(ctx context.Context, password []byte, hash []byte) error
• func CompareArgon2id(_ context.Context, password []byte, hash []byte) error
• func CompareBcrypt(_ context.Context, password []byte, hash []byte) error
• func ComparePbkdf2(_ context.Context, password []byte, hash []byte) error
• func IsArgon2idHash(hash []byte) bool
• func IsBcryptHash(hash []byte) bool
• func IsPbkdf2Hash(hash []byte) bool
• type Argon2
  • func NewHasherArgon2(c Argon2Configuration) *Argon2
  • func (h *Argon2) Generate(ctx context.Context, password []byte) ([]byte, error)
  • func (h *Argon2) Understands(hash []byte) bool
• type Argon2Configuration
• type Bcrypt
  • func NewHasherBcrypt(c BcryptConfiguration) *Bcrypt
  • func (h *Bcrypt) Generate(ctx context.Context, password []byte) ([]byte, error)
  • func (h *Bcrypt) Understands(hash []byte) bool
• type BcryptConfiguration
• type HashProvider
• type Hasher
• type Pbkdf2
  • func (h *Pbkdf2) Generate(_ context.Context, password []byte) ([]byte, error)
  • func (h *Pbkdf2) Understands(hash []byte) bool

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")
)

var ErrUnknownHashAlgorithm = errors.New("unknown hash algorithm")

Functions

func Compare

func Compare(ctx context.Context, password []byte, hash []byte) error

func CompareArgon2id

func CompareArgon2id(_ context.Context, password []byte, hash []byte) error

func CompareBcrypt

func CompareBcrypt(_ context.Context, password []byte, hash []byte) error

func ComparePbkdf2

func ComparePbkdf2(_ context.Context, password []byte, hash []byte) error

func IsArgon2idHash

func IsArgon2idHash(hash []byte) bool

func IsBcryptHash

func IsBcryptHash(hash []byte) bool

func IsPbkdf2Hash

func IsPbkdf2Hash(hash []byte) bool

Types

type Argon2

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

func NewHasherArgon2

func NewHasherArgon2(c Argon2Configuration) *Argon2

func (*Argon2) Generate

func (h *Argon2) Generate(ctx context.Context, password []byte) ([]byte, error)

func (*Argon2) Understands

func (h *Argon2) Understands(hash []byte) bool

type Argon2Configuration

type Argon2Configuration interface {
	config.Provider
}

type Bcrypt

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

func NewHasherBcrypt

func NewHasherBcrypt(c BcryptConfiguration) *Bcrypt

func (*Bcrypt) Generate

func (h *Bcrypt) Generate(ctx context.Context, password []byte) ([]byte, error)

func (*Bcrypt) Understands

func (h *Bcrypt) Understands(hash []byte) bool

type BcryptConfiguration

type BcryptConfiguration interface {
	config.Provider
}

type HashProvider

type HashProvider interface {
	Hasher() Hasher
}

type Hasher

type Hasher interface {
	// Generate returns a hash derived from the password or an error if the hash method failed.
	Generate(ctx context.Context, password []byte) ([]byte, error)

	// Understands returns whether the given hash can be understood by this hasher.
	Understands(hash []byte) bool
}

Hasher provides methods for generating and comparing password hashes.

type Pbkdf2

type Pbkdf2 struct {
	Algorithm  string
	Iterations uint32
	SaltLength uint32
	KeyLength  uint32
}

func (*Pbkdf2) Generate

func (h *Pbkdf2) Generate(_ context.Context, password []byte) ([]byte, error)

func (*Pbkdf2) Understands

func (h *Pbkdf2) Understands(hash []byte) bool