sour-is/go-passwd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

chore: add recommendations to documentation of hash functions.

Browse Source
This commit is contained in:
Jon Lundy 2022-12-09 10:05:39 -07:00
parent 60ce81e5fe
commit a4bb55f56a
Signed by untrusted user who does not match committer: xuu
GPG Key ID: C63E6D61F3035024
3 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -9,11 +9,11 @@ Here is an example of usage:
```go ```go
func Example() { func Example() {
pass := "my_pass" pass := "my_pass"
hash := "my_pass" hash := "$1$81ed91e1131a3a5a50d8a68e8ef85fa0"
pwd := passwd.New( pwd := passwd.New(
&unix.MD5{}, // first is preferred type. argon2.Argon2id, // first is preferred type.
&plainPasswd{}, &unix.MD5{},
) )
_, err := pwd.Passwd(pass, hash) _, err := pwd.Passwd(pass, hash)
@ -32,7 +32,7 @@ func Example() {
} }
// Output: // Output:
// new hash: $1$81ed91e1131a3a5a50d8a68e8ef85fa0 // new hash: $argon2id$...
} }
``` ```
https://github.com/sour-is/go-passwd/blob/main/passwd_test.go#L33-L59 https://github.com/sour-is/go-passwd/blob/main/passwd_test.go#L33-L59

3
passwd_test.go
View File

@ -30,6 +30,9 @@ func (p *plainPasswd) ApplyPasswd(passwd *passwd.Passwd) {
passwd.SetFallthrough(p) passwd.SetFallthrough(p)
} }
// Example of upgrading password hash to a greater complexity.
//
// Note: This example uses very unsecure hash functions to allow for predictable output. Use of argon2.Argon2id or scrypt.Scrypt2 for greater hash security is recommended.
func Example() { func Example() {
pass := "my_pass" pass := "my_pass"
hash := "my_pass" hash := "my_pass"