chore: add recommendations to documentation of hash functions.

2022-12-09 10:05:39 -07:00
parent 60ce81e5fe
commit a4bb55f56a
3 changed files with 8 additions and 5 deletions
--- a/passwd_test.go
+++ b/passwd_test.go
@@ -30,6 +30,9 @@ func (p *plainPasswd) ApplyPasswd(passwd *passwd.Passwd) {
 	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() {
 	pass := "my_pass"
 	hash := "my_pass"