forked from go-gitea/gitea
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide the ability to set password hash algorithm parameters
This PR refactors and improves the password hashing code within gitea and makes it possible for server administrators to set the password hashing parameters In addition it takes the opportunity to adjust the settings for `pbkdf2` in order to make the hashing a little stronger. The majority of this work was inspired by PR go-gitea#14751 and I would like to thank @boppy for their work on this. Thanks to @Gusted for the suggestion to adjust the `pbkdf2` hashing parameters. Close go-gitea#14751 Signed-off-by: Andrew Thornton <art27@cantab.net>
- Loading branch information
Showing
26 changed files
with
734 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| // Copyright 2023 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package hash | ||
|
|
||
| import ( | ||
| "encoding/hex" | ||
| "strings" | ||
|
|
||
| "code.gitea.io/gitea/modules/log" | ||
| "golang.org/x/crypto/argon2" | ||
| ) | ||
|
|
||
| func init() { | ||
| registerHasher("argon2", NewArgon2Hasher) | ||
| } | ||
|
|
||
| // Argon2Hasher implements PasswordHasher | ||
| // and uses the Argon2 key derivation function, hybrant variant | ||
| type Argon2Hasher struct { | ||
| time uint32 | ||
| memory uint32 | ||
| threads uint8 | ||
| keyLen uint32 | ||
| } | ||
|
|
||
| // HashWithSaltBytes a provided password and salt | ||
| func (hasher *Argon2Hasher) HashWithSaltBytes(password string, salt []byte) string { | ||
| if hasher == nil { | ||
| return "" | ||
| } | ||
| return hex.EncodeToString(argon2.IDKey([]byte(password), salt, hasher.time, hasher.memory, hasher.threads, hasher.keyLen)) | ||
| } | ||
|
|
||
| // NewArgon2Hasher is a factory method to create an Argon2Hasher | ||
| // The provided config should be either empty or of the form: | ||
| // "<time>$<memory>$<threads>$<keyLen>", where <x> is the string representation | ||
| // of an integer | ||
| func NewArgon2Hasher(config string) *Argon2Hasher { | ||
| // This default configuration uses the following parameters: | ||
| // time=2, memory=64*1024, threads=8, keyLen=50. | ||
| // It will make two passes through the memory, using 64MiB in total. | ||
| hasher := &Argon2Hasher{ | ||
| time: 2, | ||
| memory: 1 << 16, | ||
| threads: 8, | ||
| keyLen: 50, | ||
| } | ||
|
|
||
| if config == "" { | ||
| return hasher | ||
| } | ||
|
|
||
| vals := strings.SplitN(config, "$", 4) | ||
| if len(vals) != 4 { | ||
| log.Error("invalid argon2 hash spec %s", config) | ||
| return nil | ||
| } | ||
|
|
||
| parsed, err := parseUIntParam(vals[0], "time", "argon2", config, nil) | ||
| hasher.time = uint32(parsed) | ||
|
|
||
| parsed, err = parseUIntParam(vals[1], "memory", "argon2", config, err) | ||
| hasher.memory = uint32(parsed) | ||
|
|
||
| parsed, err = parseUIntParam(vals[2], "threads", "argon2", config, err) | ||
| hasher.threads = uint8(parsed) | ||
|
|
||
| parsed, err = parseUIntParam(vals[3], "keyLen", "argon2", config, err) | ||
| hasher.keyLen = uint32(parsed) | ||
| if err != nil { | ||
| return nil | ||
| } | ||
|
|
||
| return hasher | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| // Copyright 2023 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package hash | ||
|
|
||
| import ( | ||
| "golang.org/x/crypto/bcrypt" | ||
| ) | ||
|
|
||
| func init() { | ||
| registerHasher("bcrypt", NewBcryptHasher) | ||
| } | ||
|
|
||
| // BcryptHasher implements PasswordHasher | ||
| // and uses the bcrypt password hash function. | ||
| type BcryptHasher struct { | ||
| cost int | ||
| } | ||
|
|
||
| // HashWithSaltBytes a provided password and salt | ||
| func (hasher *BcryptHasher) HashWithSaltBytes(password string, salt []byte) string { | ||
| if hasher == nil { | ||
| return "" | ||
| } | ||
| hashedPassword, _ := bcrypt.GenerateFromPassword([]byte(password), hasher.cost) | ||
| return string(hashedPassword) | ||
| } | ||
|
|
||
| func (hasher *BcryptHasher) VerifyPassword(password, hashedPassword, salt string) bool { | ||
| return bcrypt.CompareHashAndPassword([]byte(hashedPassword), []byte(password)) == nil | ||
| } | ||
|
|
||
| // NewBcryptHasher is a factory method to create an BcryptHasher | ||
| // The provided config should be either empty or the string representation of the "<cost>" | ||
| // as an integer | ||
| func NewBcryptHasher(config string) *BcryptHasher { | ||
| hasher := &BcryptHasher{ | ||
| cost: 10, // cost=10. i.e. 2^10 rounds of key expansion. | ||
| } | ||
|
|
||
| if config == "" { | ||
| return hasher | ||
| } | ||
| var err error | ||
| hasher.cost, err = parseIntParam(config, "cost", "bcrypt", config, nil) | ||
| if err != nil { | ||
| return nil | ||
| } | ||
|
|
||
| return hasher | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| // Copyright 2023 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package hash | ||
|
|
||
| import ( | ||
| "strconv" | ||
|
|
||
| "code.gitea.io/gitea/modules/log" | ||
| ) | ||
|
|
||
| func parseIntParam(value, param, algorithmName, config string, previousErr error) (int, error) { | ||
| parsed, err := strconv.Atoi(value) | ||
| if err != nil { | ||
| log.Error("invalid integer for %s representation in %s hash spec %s", param, algorithmName, config) | ||
| return 0, err | ||
| } | ||
| return parsed, previousErr // <- Keep the previous error as this function should still return an error once everything has been checked if any call failed | ||
| } | ||
|
|
||
| func parseUIntParam(value, param, algorithmName, config string, previousErr error) (uint64, error) { | ||
| parsed, err := strconv.ParseUint(value, 10, 64) | ||
| if err != nil { | ||
| log.Error("invalid integer for %s representation in %s hash spec %s", param, algorithmName, config) | ||
| return 0, err | ||
| } | ||
| return parsed, previousErr // <- Keep the previous error as this function should still return an error once everything has been checked if any call failed | ||
| } |
Oops, something went wrong.