forked from ava-labs/avalanchego
-
Notifications
You must be signed in to change notification settings - Fork 0
/
password.go
81 lines (69 loc) · 2.53 KB
/
password.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
// Copyright (C) 2019-2023, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package password
import (
"errors"
"fmt"
"github.com/nbutton23/zxcvbn-go"
)
// Strength is the strength of a password
type Strength int
const (
// The scoring mechanism of the zxcvbn package is defined as follows:
// 0 # too guessable: risky password. (guesses < 10^3)
// 1 # very guessable: protection from throttled online attacks. (guesses < 10^6)
// 2 # somewhat guessable: protection from unthrottled online attacks. (guesses < 10^8)
// 3 # safely unguessable: moderate protection from offline slow-hash scenario. (guesses < 10^10)
// 4 # very unguessable: strong protection from offline slow-hash scenario. (guesses >= 10^10)
// Note: We could use the iota keyword to define each of the below consts, but I think in this case
// it's better to be explicit
// VeryWeak password
VeryWeak = 0
// Weak password
Weak = 1
// Fair password
Fair = 2
// Strong password
Strong = 3
// VeryStrong password
VeryStrong = 4
// OK password is the recommended minimum strength for API calls
OK = Fair
// maxCheckedPassLen limits the length of the password that should be
// strength checked.
//
// As per issue https://github.com/VidarSolutions/avalanchego/issues/195 it was found
// the longer the length of password the slower zxcvbn.PasswordStrength()
// performs. To avoid performance issues, and a DoS vector, we only strength
// check the first 50 characters of the password.
maxCheckedPassLen = 50
// maxPassLen is the maximum allowed password length
maxPassLen = 1024
)
var (
errEmptyPassword = errors.New("empty password")
errPassMaxLength = fmt.Errorf("password exceeds maximum length of %d chars", maxPassLen)
errWeakPassword = errors.New("password is too weak")
)
// SufficientlyStrong returns true if [password] has strength greater than or
// equal to [minimumStrength]
func SufficientlyStrong(password string, minimumStrength Strength) bool {
if len(password) > maxCheckedPassLen {
password = password[:maxCheckedPassLen]
}
return zxcvbn.PasswordStrength(password, nil).Score >= int(minimumStrength)
}
// IsValid returns nil if [password] is a reasonable length and has strength
// greater than or equal to [minimumStrength]
func IsValid(password string, minimumStrength Strength) error {
switch {
case len(password) == 0:
return errEmptyPassword
case len(password) > maxPassLen:
return errPassMaxLength
case !SufficientlyStrong(password, minimumStrength):
return errWeakPassword
default:
return nil
}
}