README
¶
Crypt
Crypt implementation in pure Go. It provides a unified interface to varous hashing algorithms for key derivation.
Example
func main() {
password := "password"
settings := "$argon2id$v=19$m=65536,t=2,p=4$c2FsdHNhbHQ" // salt = "saltsalt"
encoded, err := crypt.Crypt(password, settings)
if err != nil {
log.Fatal(err)
}
fmt.Println(encoded)
// Output: $argon2id$v=19$m=65536,t=2,p=4$c2FsdHNhbHQ$mxUf7CB5gEwtDSiHfZCvxj17E8XeTFh2fpti1ioD3SA
}
Algorithm
Currently, the following algorithms are supported:
| Code | Name | Example |
|---|---|---|
| 1 | MD5 | $1$deadbeef$Q7g0UO4hRC0mgQUQ/qkjZ0 |
| 5 | SHA256 | $5$saltstring$5B8vYYiY.CVt1RlTTf8KbXBH3hsxY/GNooZaBBGWEc5 |
| 6 | SHA512 | $6$saltstring$svn8UoSVapNtMuq1ukKS4tPQd8iKwSMHWjl/O817G3uBnIFNjnQJuesI68u4OTLiBFdcbYEdFCoEOfaS35inz1 |
| 2a | bcrypt | $2a$05$/OK.fbVrR/bpIqNJ5ianF.Sa7shbm4.OzKpvFnX1pQLmQW96oUlCq |
| argon2i | Argon2i | $argon2i$v=19$m=65536,t=2$c29tZXNhbHQ$IMit9qkFULCMA/ViizL57cnTLOa5DiVM9eMwpAvPwr4 |
| argon2id | Argon2id | $argon2id$v=19$m=65536,t=2,p=4$c29tZXNhbHQ$GpZ3sK/oH9p7VIiV56G/64Zo/8GaUw434IimaPqxwCo |
It's recommended that you used argon2id for crypting passwords.
Links
This implementation is inspired by crypt.
License
The code is licensed under Apache 2.0
Documentation
¶
Index ¶
- Constants
- Variables
- func Argon2iSettings(m, t, p, k int, salts ...string) (string, error)
- func Argon2idSettings(m, t, p, k int, salts ...string) (string, error)
- func BCryptSettings(cost int, salts ...string) (string, error)
- func Crypt(password, settings string) (string, error)
- func Encode24BitBase64(src []byte) []byte
- func RegisterAlgorithm(prefix string, algorithm Algorithm)
- func Settings(settings string) string
- type Algorithm
- type Parameter
Constants ¶
const Argon2iPrefix = "$argon2i$"
Argon2iPrefix defines the settings prefix for argon2i hashes.
const Argon2idPrefix = "$argon2id$"
Argon2idPrefix defines the settings prefix for argon2id hashes.
const BCryptPrefix = "$2a$"
BCryptPrefix defines the settings prefix for bcrypt hashes.
const MD5Prefix = "$1$"
MD5Prefix defines the settings prefix for md5 hashes.
const SHA256Prefix = "$5$"
SHA256Prefix defines the settings prefix for sha256 hashes.
const SHA512Prefix = "$6$"
SHA512Prefix defines the settings prefix for sha512 hashes.
Variables ¶
var Base64Encoding = base64.StdEncoding.WithPadding(base64.NoPadding)
Base64Encoding implements the crypt-specific base63 encoding.
Functions ¶
func Argon2iSettings ¶
Argon2iSettings returns argon2i settings with the provided parameter.
func Argon2idSettings ¶ added in v0.2.0
Argon2idSettings returns argon2id settings with the provided parameter.
func BCryptSettings ¶
BCryptSettings returns bcrypt settings with the provided parameter.
func Encode24BitBase64 ¶
Encode24BitBase64 implements a special version of base64 that is used with md5, sha256 and sha512.
func RegisterAlgorithm ¶
RegisterAlgorithm registers an algorithm under the provided prefix.
Source Files
Directories