Skip to content

Commit

Permalink
chore(docs): add go report card (#13)
Browse files Browse the repository at this point in the history
* chore(docs): add go report card

fix misspellings

* update go version support

---------

Co-authored-by: Livio Spring <[email protected]>
  • Loading branch information
muhlemmer and livio-a authored Sep 18, 2023
1 parent f76c656 commit 7859b39
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 7 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![Go Reference](https://pkg.go.dev/badge/github.com/zitadel/passwap.svg)](https://pkg.go.dev/github.com/zitadel/passwap)
[![Go](https://github.com/zitadel/passwap/actions/workflows/go.yml/badge.svg)](https://github.com/zitadel/passwap/actions/workflows/go.yml)
[![codecov](https://codecov.io/gh/zitadel/passwap/branch/main/graph/badge.svg?token=GrPT2nbCjj)](https://codecov.io/gh/zitadel/passwap)
[![Go Report Card](https://goreportcard.com/badge/github.com/zitadel/passwap)](https://goreportcard.com/report/github.com/zitadel/passwap)

Package Passwap provides a unified implementation between
different password hashing algorithms in the Go ecosystem.
Expand Down Expand Up @@ -171,8 +172,9 @@ Versions that also build are marked with :warning:.
| ------- | ------------------ |
| <1.18 | :x: |
| 1.18 | :warning: |
| 1.19 | :white_check_mark: |
| 1.19 | :warning: |
| 1.20 | :white_check_mark: |
| 1.21 | :white_check_mark: |

## License

Expand Down
4 changes: 2 additions & 2 deletions argon2/argon2.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ var (
// See https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md.
const Format = "$%s$v=%d$m=%d,t=%d,p=%d$%s$%s"

// scanning needs a space seperated string, instead of dollar signs.
// scanning needs a space separated string, instead of dollar signs.
var scanFormat = strings.ReplaceAll(Format, "$", " ")

var (
Expand Down Expand Up @@ -87,7 +87,7 @@ func parse(encoded string) (*checker, error) {
c checker
)

// scanning needs a space seperated string, instead of dollar signs.
// scanning needs a space separated string, instead of dollar signs.
encoded = strings.ReplaceAll(encoded, "$", " ")

_, err := fmt.Sscanf(encoded, scanFormat, &c.id, &version, &c.Memory, &c.Time, &c.Threads, &salt, &hash)
Expand Down
2 changes: 1 addition & 1 deletion md5/md5.go
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ func parse(encoded string) (*checker, error) {
return nil, nil
}

// scanning needs a space seperated string, instead of dollar signs.
// scanning needs a space separated string, instead of dollar signs.
encoded = strings.ReplaceAll(encoded, "$", " ")
var c checker

Expand Down
2 changes: 1 addition & 1 deletion passwap.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ func (e SkipErrors) Error() string {
// Hasher or the cost parameters differ, an updated encoded hash
// string is returned for the same (valid) password.
// In all other cases updated remains empty.
// When updated is not empty, it must be stored untill next use.
// When updated is not empty, it must be stored until next use.
func (s *Swapper) Verify(encoded, password string) (updated string, err error) {
return s.verifyAndUpdate(encoded, password, password)
}
Expand Down
2 changes: 1 addition & 1 deletion pbkdf2/pbkdf2.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ func parse(encoded string) (*checker, error) {
c checker
)

// scanning needs a space seperated string, instead of dollar signs.
// scanning needs a space separated string, instead of dollar signs.
encoded = strings.ReplaceAll(encoded, "$", " ")

_, err := fmt.Sscanf(encoded, scanFormat, &c.id, &c.Rounds, &salt, &hash)
Expand Down
2 changes: 1 addition & 1 deletion scrypt/scrypt.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ func parse(encoded string) (*checker, error) {
c checker
)

// scanning needs a space seperated string, instead of dollar signs.
// scanning needs a space separated string, instead of dollar signs.
encoded = strings.ReplaceAll(encoded, "$", " ")

_, err := fmt.Sscanf(encoded, scanFormat, &id, &ln, &c.R, &c.P, &salt, &hash)
Expand Down

0 comments on commit 7859b39

Please sign in to comment.