Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support wildcards in email domain whitelisting #20257

Closed
wants to merge 17 commits into from
Closed

Support wildcards in email domain whitelisting #20257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
b69dda0
added code to match on asterisk wildcard
KingBain Jul 5, 2022
2d358ee
updated test to validate wildcard
KingBain Jul 5, 2022
4bc90fb
updated change to use glob for pattern matching
KingBain Jul 8, 2022
d85cdd2
should resolve issue with liniting
KingBain Jul 8, 2022
4488d97
Update services/forms/user_form.go
KingBain Jul 11, 2022
8063c65
made changes to use an array of compiled globs
KingBain Jul 22, 2022
f413f48
Merge branch 'main' into main
KingBain Jul 22, 2022
b47326d
Merge branch 'main' into main
KingBain Sep 8, 2022
5cba7be
Moved BuildEmailGlobs to service.go
KingBain Sep 12, 2022
3778a30
called BuildEmailGlobs from settings pkg
KingBain Sep 12, 2022
cc023a4
Merge branch 'main' into main
KingBain Sep 12, 2022
e4135bc
Merge branch 'go-gitea:main' into main
KingBain Sep 12, 2022
55b21a7
included capturing glob compile erro catching.
KingBain Sep 15, 2022
dbafa36
space added to import statements, local variable name made lowercase.
KingBain Oct 24, 2022
7752c87
updaed message to show glob will be skipped
KingBain Oct 24, 2022
404685a
added space to import statements
KingBain Oct 24, 2022
8887b15
Merge branch 'go-gitea:main' into main
KingBain Oct 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions modules/setting/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import (

"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/structs"

"github.com/gobwas/glob"
KingBain marked this conversation as resolved.
Show resolved Hide resolved
)

// Service settings
Expand All @@ -25,8 +27,8 @@ var Service = struct {
ResetPwdCodeLives int
RegisterEmailConfirm bool
RegisterManualConfirm bool
EmailDomainWhitelist []string
EmailDomainBlocklist []string
EmailDomainWhitelist []glob.Glob
EmailDomainBlocklist []glob.Glob
DisableRegistration bool
AllowOnlyInternalRegistration bool
AllowOnlyExternalRegistration bool
Expand Down Expand Up @@ -103,6 +105,23 @@ func (a AllowedVisibility) ToVisibleTypeSlice() (result []structs.VisibleType) {
return result
}

// BuildEmailGlobs takes in an array of strings and
// builds an array of compiled globs used to do
// pattern matching in IsEmailDomainAllowed. A compiled list
func BuildEmailGlobs(list []string) []glob.Glob {
var emaillist []glob.Glob

for _, s := range list {
if g, err := glob.Compile(s); err == nil {
emaillist = append(emaillist, g)
} else {
log.Warn("Invalid glob expression %q (skipped): %v", s, err)
}
}

return emaillist
}

func newService() {
sec := Cfg.Section("service")
Service.ActiveCodeLives = sec.Key("ACTIVE_CODE_LIVE_MINUTES").MustInt(180)
Expand All @@ -119,8 +138,8 @@ func newService() {
} else {
Service.RegisterManualConfirm = false
}
Service.EmailDomainWhitelist = sec.Key("EMAIL_DOMAIN_WHITELIST").Strings(",")
Service.EmailDomainBlocklist = sec.Key("EMAIL_DOMAIN_BLOCKLIST").Strings(",")
Service.EmailDomainWhitelist = BuildEmailGlobs(sec.Key("EMAIL_DOMAIN_WHITELIST").Strings(","))
Service.EmailDomainBlocklist = BuildEmailGlobs(sec.Key("EMAIL_DOMAIN_BLOCKLIST").Strings(","))
Service.ShowRegistrationButton = sec.Key("SHOW_REGISTRATION_BUTTON").MustBool(!(Service.DisableRegistration || Service.AllowOnlyExternalRegistration))
Service.ShowMilestonesDashboardPage = sec.Key("SHOW_MILESTONES_DASHBOARD_PAGE").MustBool(true)
Service.RequireSignInView = sec.Key("REQUIRE_SIGNIN_VIEW").MustBool()
Expand Down
8 changes: 5 additions & 3 deletions services/forms/user_form.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ import (
"code.gitea.io/gitea/modules/web/middleware"

"gitea.com/go-chi/binding"

KingBain marked this conversation as resolved.
Show resolved Hide resolved
KingBain marked this conversation as resolved.
Show resolved Hide resolved
"github.com/gobwas/glob"
)

// InstallForm form for installation page
Expand Down Expand Up @@ -107,7 +109,7 @@ func (f *RegisterForm) Validate(req *http.Request, errs binding.Errors) binding.

// IsEmailDomainListed checks whether the domain of an email address
// matches a list of domains
func IsEmailDomainListed(list []string, email string) bool {
func IsEmailDomainListed(list []glob.Glob, email string) bool {
if len(list) == 0 {
return false
}
Expand All @@ -119,8 +121,8 @@ func IsEmailDomainListed(list []string, email string) bool {

domain := strings.ToLower(email[n+1:])

for _, v := range list {
if strings.ToLower(v) == domain {
for _, l := range list {
if l.Match(domain) {
return true
}
}
Expand Down
12 changes: 7 additions & 5 deletions services/forms/user_form_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
func TestRegisterForm_IsDomainAllowed_Empty(t *testing.T) {
_ = setting.Service

setting.Service.EmailDomainWhitelist = []string{}
setting.Service.EmailDomainWhitelist = setting.BuildEmailGlobs([]string{})

form := RegisterForm{}

Expand All @@ -25,7 +25,7 @@ func TestRegisterForm_IsDomainAllowed_Empty(t *testing.T) {
func TestRegisterForm_IsDomainAllowed_InvalidEmail(t *testing.T) {
_ = setting.Service

setting.Service.EmailDomainWhitelist = []string{"gitea.io"}
setting.Service.EmailDomainWhitelist = setting.BuildEmailGlobs([]string{"gitea.io"})

tt := []struct {
email string
Expand All @@ -44,7 +44,7 @@ func TestRegisterForm_IsDomainAllowed_InvalidEmail(t *testing.T) {
func TestRegisterForm_IsDomainAllowed_WhitelistedEmail(t *testing.T) {
_ = setting.Service

setting.Service.EmailDomainWhitelist = []string{"gitea.io"}
setting.Service.EmailDomainWhitelist = setting.BuildEmailGlobs([]string{"gitea.io", "*.gc.ca"})

tt := []struct {
email string
Expand All @@ -54,6 +54,7 @@ func TestRegisterForm_IsDomainAllowed_WhitelistedEmail(t *testing.T) {
{"security@gITea.io", true},
{"hdudhdd", false},
{"seee@example.com", false},
{"security@fishsauce.gc.ca", true},
}

for _, v := range tt {
Expand All @@ -66,8 +67,8 @@ func TestRegisterForm_IsDomainAllowed_WhitelistedEmail(t *testing.T) {
func TestRegisterForm_IsDomainAllowed_BlocklistedEmail(t *testing.T) {
_ = setting.Service

setting.Service.EmailDomainWhitelist = []string{}
setting.Service.EmailDomainBlocklist = []string{"gitea.io"}
setting.Service.EmailDomainWhitelist = setting.BuildEmailGlobs([]string{})
setting.Service.EmailDomainBlocklist = setting.BuildEmailGlobs([]string{"gitea.io", "*.gov"})

tt := []struct {
email string
Expand All @@ -76,6 +77,7 @@ func TestRegisterForm_IsDomainAllowed_BlocklistedEmail(t *testing.T) {
{"security@gitea.io", false},
{"security@gitea.example", true},
{"hdudhdd", true},
{"security@fishsauce.gov", false},
}

for _, v := range tt {
Expand Down