-
Notifications
You must be signed in to change notification settings - Fork 0
/
utils.go
201 lines (187 loc) · 7.08 KB
/
utils.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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
package main
import (
"errors"
"fmt"
"regexp"
"strings"
"golang.org/x/crypto/bcrypt"
)
var (
// EmailLocalpartMaxLength sets the maximum length of the email address's localpart
EmailLocalpartMaxLength = 63
// EmailDomainpartMaxLength sets the maximum length of the email address's domain
EmailDomainpartMaxLength = 253
// PasswordMinimumLength sets the minimum length of the password
PasswordMinimumLength = 8
// PasswordMandatorySpecialCharacters indicates whether special characters are mandatory
PasswordMandatorySpecialCharacters = true
// PasswordMandatoryNumbers indicates whether numerical characters are mandatory
PasswordMandatoryNumbers = true
// UsernameMinLength sets the minimum length of the username
UsernameMinLength = 4
// UsernameMaxLength sets the maximum length of the username
UsernameMaxLength = 64
// UtilsErrorEmail is the error when the email is invalid
UtilsErrorEmail = "E_EMAIL_INVALID"
)
// ValidationError provides a standardised error structure
// for validation errors
type ValidationError struct {
Code string
Message string
}
// Error enables ValidationError to be processed as an error type
func (validationError *ValidationError) Error() string {
return fmt.Sprintf("%s: %s", validationError.Code, validationError.Message)
}
// UtilityFunctions module provides utility functions for the rest of
// of the service
type UtilityFunctions struct{}
// export it for use globally
var utils = UtilityFunctions{}
// CreatePasswordHash creates a hash give nthe password :password
func (*UtilityFunctions) CreatePasswordHash(password string) (string, error) {
inBytes := []byte(password)
hashedBytes, err := bcrypt.GenerateFromPassword(inBytes, bcrypt.DefaultCost)
if err != nil {
return "", err
}
return string(hashedBytes[:]), nil
}
// VerifyPasswordHash verifies that the provided :password when hashed
// equals the :hash
func (*UtilityFunctions) VerifyPasswordHash(password string, hash string) error {
inBytes := []byte(password)
hashedBytes := []byte(hash)
return bcrypt.CompareHashAndPassword(hashedBytes, inBytes)
}
// ValidateEmail returns an error if the :email is not valid
func (utility *UtilityFunctions) ValidateEmail(email string) error {
emailParts := strings.Split(email, "@")
if len(emailParts) != 2 {
return errors.New(UtilsErrorEmail)
}
localPart := emailParts[0]
if err := utility.validateEmailLocalPart(localPart); err != nil {
return err
}
domainPart := emailParts[1]
if err := utility.validateEmailDomainPart(domainPart); err != nil {
return err
}
return nil
}
// ValidatePassword returns an error if the :password is not valid
func (utility *UtilityFunctions) ValidatePassword(password string) error {
specialCharacters := "`~!@#$%^&*()_+-={}[]\\|;:'\",<.>/?"
if len(password) < PasswordMinimumLength {
return &ValidationError{
Code: "E_PASSWORD_TOO_SHORT",
Message: fmt.Sprintf("password should be at least of length %v", PasswordMinimumLength),
}
} else if !strings.ContainsAny(password, specialCharacters) {
return &ValidationError{
Code: "E_PASSWORD_NO_SPECIAL_CHARACTERS",
Message: "password should contain at least one special character",
}
} else if !strings.ContainsAny(password, "1234567890") {
return &ValidationError{
Code: "E_PASSWORD_NO_NUMBERS",
Message: "password should contain at least one numerical character",
}
}
return nil
}
// ValidateUsername validates the username :username
func (*UtilityFunctions) ValidateUsername(username string) error {
test, err := regexp.Compile(`^[a-zA-Z0-9]+[a-zA-Z0-9_\-\.]*[a-zA-Z0-9]$`)
if err != nil {
panic(err)
}
if len(username) < UsernameMinLength {
return &ValidationError{
Code: "E_USERNAME_TOO_SHORT",
Message: fmt.Sprintf("username ('%v') should be more than %v characters", username, UsernameMinLength-1),
}
}
if len(username) > UsernameMaxLength {
return &ValidationError{
Code: "E_USERNAME_TOO_LONG",
Message: fmt.Sprintf("username ('%v') should be less than %v characters", username, UsernameMaxLength),
}
}
if !test.MatchString(username) {
return &ValidationError{
Code: "E_USERNAME_INVALID_CHARACTERS",
Message: fmt.Sprintf("username ('%v') should be alpha-numeric and cannot start/end with any of [-, _, .]", username),
}
}
return nil
}
func (*UtilityFunctions) validateEmailLocalPart(localPart string) error {
specialCharacters := "!#$%^&*()=\\|;:\"'<>,/?[]{}`~"
invalidStartingAndEndingCharacters := "-_+."
if len(localPart) > EmailLocalpartMaxLength {
return &ValidationError{
Code: "E_EMAIL_LOCALPART_TOO_LONG",
Message: fmt.Sprintf("email username ('%v') should be less than %v characters", localPart, EmailLocalpartMaxLength),
}
}
if strings.ContainsAny(localPart, specialCharacters) {
return &ValidationError{
Code: "E_EMAIL_LOCALPART_SPECIAL_CHARS",
Message: fmt.Sprintf("email username ('%v') should not contain any special characters", localPart),
}
}
if strings.LastIndexAny(localPart, invalidStartingAndEndingCharacters) == len(localPart)-1 {
return &ValidationError{
Code: "E_EMAIL_LOCALPART_INVALID_POSTFIX",
Message: fmt.Sprintf("email username ('%v') should not end with any of %v", localPart, invalidStartingAndEndingCharacters),
}
}
if strings.IndexAny(localPart, invalidStartingAndEndingCharacters) == 0 {
return &ValidationError{
Code: "E_EMAIL_LOCALPART_INVALID_PREFIX",
Message: fmt.Sprintf("email username ('%v') should not end with any of %v", localPart, invalidStartingAndEndingCharacters),
}
}
return nil
}
func (UtilityFunctions) validateEmailDomainPart(domainPart string) error {
specialCharacters := "!#$%^&*()=\\|;:\"'<>,/?[]{}`~+_"
invalidStartingAndEndingCharacters := "-"
if len(domainPart) > EmailDomainpartMaxLength {
return &ValidationError{
Code: "E_EMAIL_DOMAIN_TOO_LONG",
Message: fmt.Sprintf("email domain ('%v') should not be more than length %v", domainPart, EmailDomainpartMaxLength),
}
}
domainParts := strings.Split(domainPart, ".")
if len(domainParts) < 2 {
return &ValidationError{
Code: "E_EMAIL_DOMAINPART_INVALID",
Message: fmt.Sprintf("email domain ('%v') should not be of a TLD", domainPart),
}
}
for _, domainPartSubsection := range domainParts {
if strings.ContainsAny(domainPartSubsection, specialCharacters) {
return &ValidationError{
Code: "E_EMAIL_SPECIAL_CHARS",
Message: fmt.Sprintf("email domain part ('%v') should not contain any special characters (%v)", domainPartSubsection, specialCharacters),
}
}
if strings.LastIndexAny(domainPartSubsection, invalidStartingAndEndingCharacters) == len(domainPartSubsection)-1 {
return &ValidationError{
Code: "E_EMAIL_INVALID_DOMAINPART_POSTFIX",
Message: fmt.Sprintf("email domain part ('%v') should not end with any of %v", domainPartSubsection, invalidStartingAndEndingCharacters),
}
}
if strings.IndexAny(domainPartSubsection, invalidStartingAndEndingCharacters) == 0 {
return &ValidationError{
Code: "E_EMAIL_INVALID_DOMINPART_PREFIX",
Message: fmt.Sprintf("email domain part ('%v') should not begin with any of %v", domainPartSubsection, invalidStartingAndEndingCharacters),
}
}
}
return nil
}