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

Fix typos and improve code blocks #1

Merged
der-lyse merged 1 commits from main into main 2022-12-08 19:48:03 -07:00
Conversation 0 Commits 1 Files Changed 1 +7 -7
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 343f17a37f - Show all commits

14
README.md
View File

@ -6,7 +6,7 @@
Here is an example of usage: Here is an example of usage:
``` ```go
func Example() { func Example() {
pass := "my_pass" pass := "my_pass"
hash := "my_pass" hash := "my_pass"
@ -42,11 +42,11 @@ This shows how one would set a preferred hashing type and if the current version
# Fallthrough # Fallthrough
> Hold up now, that example hash doesn’t have a $ prefix! > Hold up now, that example hash doesn’t have a `$` prefix!
Well for this there is the option for a hash type to set itself as a fall through if a matching hash doesn’t exist. This is good for legacy password types that don’t follow the convention. Well for this there is the option for a hash type to set itself as a fall through if a matching hash doesn’t exist. This is good for legacy password types that don’t follow the convention.
``` ```go
func (p *plainPasswd) ApplyPasswd(passwd *passwd.Passwd) { func (p *plainPasswd) ApplyPasswd(passwd *passwd.Passwd) {
passwd.Register("plain", p) passwd.Register("plain", p)
passwd.SetFallthrough(p) passwd.SetFallthrough(p)
@ -56,11 +56,11 @@ func (p *plainPasswd) ApplyPasswd(passwd *passwd.Passwd) {
https://github.com/sour-is/go-passwd/blob/main/passwd_test.go#L28-L31 https://github.com/sour-is/go-passwd/blob/main/passwd_test.go#L28-L31
# Custom Prefence checks # Custom Preference Checks
Circling back to the IsPreferred method. A hasher can define its own IsPreferred method that will be called to check if the current hash meets the complexity requirements. This is good for updating the password hashes to be more secure over time. Circling back to the `IsPreferred` method. A hasher can define its own `IsPreferred` method that will be called to check if the current hash meets the complexity requirements. This is good for updating the password hashes to be more secure over time.
``` ```go
func (p *Passwd) IsPreferred(hash string) bool { func (p *Passwd) IsPreferred(hash string) bool {
_, algo := p.getAlgo(hash) _, algo := p.getAlgo(hash)
if algo != nil && algo == p.d { if algo != nil && algo == p.d {
@ -78,4 +78,4 @@ func (p *Passwd) IsPreferred(hash string) bool {
https://github.com/sour-is/go-passwd/blob/main/passwd.go#L62-L74 https://github.com/sour-is/go-passwd/blob/main/passwd.go#L62-L74
example: https://github.com/sour-is/go-passwd/blob/main/pkg/argon2/argon2.go#L104-L133 Example: https://github.com/sour-is/go-passwd/blob/main/pkg/argon2/argon2.go#L104-L133