argon2id

Documentation

Index

• Variables
• func Verify(password []byte, hash *Hash) bool
• type Hash
  • func Decode(encodedHash string) (*Hash, error)
  • func (hash *Hash) Encode() string
• type Hasher
  • func (hasher *Hasher) Hash(password []byte, salt []byte) Hash

Variables

var ErrInvalidHash = errors.New("invalid hash")

ErrInvalidHash is returned when an invalid hash is provided.

Functions

func Verify

func Verify(password []byte, hash *Hash) bool

Verify verifies the given password against the given Argon2ID hash. Returns true if the password matches the hash, false otherwise.

Types

type Hash

type Hash struct {
	Hash        []byte
	Salt        []byte
	Memory      uint32
	Iterations  uint32
	Parallelism uint8
}

Hash represents the Argon2ID hash.

func Decode

func Decode(encodedHash string) (*Hash, error)

Decode decodes an Argon2ID hash from a string representation.

func (*Hash) Encode

func (hash *Hash) Encode() string

Encode encodes the Argon2ID hash into a string representation.

type Hasher

type Hasher struct {
	Memory      uint32
	Iterations  uint32
	Parallelism uint8
	HashLength  uint32
}

Hasher represents an Argon2ID hasher.

func (*Hasher) Hash

func (hasher *Hasher) Hash(password []byte, salt []byte) Hash

Hash computes the Argon2ID hash of the given password and salt.