hash

Documentation

Index

• Variables
• func Compare(ctx context.Context, password []byte, hash []byte) error
• func CompareArgon2i(_ 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 CompareFirebaseScrypt(_ context.Context, password []byte, hash []byte) error
• func CompareMD5(_ context.Context, password []byte, hash []byte) error
• func CompareMD5Crypt(_ context.Context, password []byte, hash []byte) error
• func ComparePbkdf2(_ context.Context, password []byte, hash []byte) error
• func CompareSHA(_ context.Context, password []byte, hash []byte) error
• func CompareSHA256Crypt(_ context.Context, password []byte, hash []byte) error
• func CompareSHA512Crypt(_ context.Context, password []byte, hash []byte) error
• func CompareSSHA(_ context.Context, password []byte, hash []byte) error
• func CompareScrypt(_ context.Context, password []byte, hash []byte) error
• func IsArgon2iHash(hash []byte) bool
• func IsArgon2idHash(hash []byte) bool
• func IsBcryptHash(hash []byte) bool
• func IsFirebaseScryptHash(hash []byte) bool
• func IsMD5CryptHash(hash []byte) bool
• func IsMD5Hash(hash []byte) bool
• func IsPbkdf2Hash(hash []byte) bool
• func IsSHA256CryptHash(hash []byte) bool
• func IsSHA512CryptHash(hash []byte) bool
• func IsSHAHash(hash []byte) bool
• func IsSSHAHash(hash []byte) bool
• func IsScryptHash(hash []byte) bool
• func IsSip24Hash(hash []byte) bool
• func IsValidHashFormat(hash []byte) bool
• func NewCryptDecoder() *crypt.Decoder
• 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(ctx context.Context, password []byte) ([]byte, error)
  • func (h *Pbkdf2) Understands(hash []byte) bool
• type Scrypt
  • func NewHasherScrypt(c *ScryptConfiguration) *Scrypt
  • func (h *Scrypt) Generate(ctx context.Context, password []byte) ([]byte, error)
  • func (h *Scrypt) Understands(hash []byte) bool
• type ScryptConfiguration
• type SipHash24
  • func NewHasherSipHash24(c *SipHashConfiguration) *SipHash24
  • func (h *SipHash24) Generate(ctx context.Context, data []byte) ([]byte, error)
  • func (h *SipHash24) Understands(hash []byte) bool
• type SipHashConfiguration

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 CryptDecoder = NewCryptDecoder()

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

Functions

func Compare

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

func CompareArgon2i

func CompareArgon2i(_ 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 CompareFirebaseScrypt

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

func CompareMD5

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

func CompareMD5Crypt

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

func ComparePbkdf2

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

func CompareSHA

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

func CompareSHA256Crypt

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

func CompareSHA512Crypt

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

func CompareSSHA

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

func CompareScrypt

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

func IsArgon2iHash

func IsArgon2iHash(hash []byte) bool

func IsArgon2idHash

func IsArgon2idHash(hash []byte) bool

func IsBcryptHash

func IsBcryptHash(hash []byte) bool

func IsFirebaseScryptHash

func IsFirebaseScryptHash(hash []byte) bool

func IsMD5CryptHash

func IsMD5CryptHash(hash []byte) bool

func IsMD5Hash

func IsMD5Hash(hash []byte) bool

func IsPbkdf2Hash

func IsPbkdf2Hash(hash []byte) bool

func IsSHA256CryptHash

func IsSHA256CryptHash(hash []byte) bool

func IsSHA512CryptHash

func IsSHA512CryptHash(hash []byte) bool

func IsSHAHash

func IsSHAHash(hash []byte) bool

func IsSSHAHash

func IsSSHAHash(hash []byte) bool

func IsScryptHash

func IsScryptHash(hash []byte) bool

func IsSip24Hash

func IsSip24Hash(hash []byte) bool

func IsValidHashFormat

func IsValidHashFormat(hash []byte) bool

func NewCryptDecoder

func NewCryptDecoder() *crypt.Decoder

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 struct {
	Parallelism uint8
	Memory      bytesize.ByteSize
	Iterations  uint32
	SaltLength  uint8
	KeyLength   uint32
}

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 struct {
	Cost int
}

type HashProvider

type HashProvider interface {
	Hasher(ctx context.Context) Hasher
}

type Hasher

type Hasher interface {
	// Generate returns a hash derived from the secret or an error if the hash method failed.
	Generate(ctx context.Context, secret []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 secret hashes.

type Pbkdf2

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

func (*Pbkdf2) Generate

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

func (*Pbkdf2) Understands

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

type Scrypt

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

func NewHasherScrypt

func NewHasherScrypt(c *ScryptConfiguration) *Scrypt

func (*Scrypt) Generate

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

func (*Scrypt) Understands

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

type ScryptConfiguration

type ScryptConfiguration struct {
	Cost            uint32
	Block           uint32
	Parallelization uint32
	SaltLength      uint32
	KeyLength       uint32
}

type SipHash24

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

func NewHasherSipHash24

func NewHasherSipHash24(c *SipHashConfiguration) *SipHash24

func (*SipHash24) Generate

func (h *SipHash24) Generate(ctx context.Context, data []byte) ([]byte, error)

func (*SipHash24) Understands

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

type SipHashConfiguration

type SipHashConfiguration struct {
	Key string
}