README
¶
Argon2
An Argon2 hash encoder and decoder for Go with sql.Scanner and driver.Valuer implemented.
- Implemented
sql.Sanneranddriver.Valuerto read to and write from SQL databases.
Usage
go get github.com/merajsahebdar/argon2
type User struct {
ID uint64
Password argon2.Argon2
}
func (e User) IsPasswordCorrect(toCompare string) bool {
if err := e.Password.Compare(toCompare); err != nil {
return false
}
return true
}
func NewUser() *User {
return &User{
ID: 1,
Password: argon2.MustNew(),
}
}
License
This module is licensed under Apache 2.0 as found in the LICENSE file.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrInvalidEncodedHash is returned when the encoded hash is in an invalid format. ErrInvalidEncodedHash = errors.New("the encoded hash is not in the correct format") // ErrIncompatibleVersion is returned when the encoded hash generated // using a different version of argon2. ErrIncompatibleVersion = errors.New("incompatible version of argon2") // ErrScan is returned when the given value to scanner cannot be represented as a ULID. ErrScan = errors.New("cannot scan the given value") // ErrMismatched is returned when the given value to compare is not the same as the current hashed value. ErrMismatched = errors.New("the given value is not the same as the current hashed value") )
Functions ¶
Types ¶
type Argon2 ¶
type Argon2 struct {
// contains filtered or unexported fields
}
Argon2 provides Argon2 based hashing operations.
func NewByEncoded ¶
NewByEncoded returns a new argon2.Argon2 by decoding the given previously encoded hash.
Source Files
Click to show internal directories.
Click to hide internal directories.