feat(user): remove support for case-sensitive username

marjune163 · marjune163 · commit bac2905e5ca8 · 2024-01-30T20:51:33.000+08:00
BREAKING CHANGE

Before:

Use `--user-match-case` to make username case sensitive. If the option
is not present, username is case-insensitive.

After:

Username is always case-insensitive. `--user-match-case` is removed.
diff --git a/README.md b/README.md
@@ -240,8 +240,6 @@ ghfs [options]
 --user-sha256 [<username>]:<sha256-password> ...
 --user-sha512 [<username>]:<sha512-password> ...
     Specify users for Basic Auth, with encoded password.
---user-match-case
-    Username is case sensitive.
 
 -c|--cert <file> ...
     Specify TLS certificate file.
diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -230,8 +230,6 @@ ghfs [选项]
 --user-sha256 [<用户名>]:<sha256密码> ...
 --user-sha512 [<用户名>]:<sha512密码> ...
     指定http基本验证的用户，对密码使用特定的编码。
---user-match-case
-    用户名区分大小写。
 
 -c|--cert <证书文件> ...
     指定TLS证书文件。
diff --git a/src/param/cli.go b/src/param/cli.go
@@ -132,9 +132,6 @@ func NewCliCmd() *goNixArgParser.Command {
 	err = options.AddFlagValues("userssha512", "--user-sha512", "", nil, "user info: <username>:<sha512-password>")
 	serverError.CheckFatal(err)
 
-	err = options.AddFlag("usermatchcase", "--user-match-case", "GHFS_USER_MATCH_CASE", "username should be case sensitive")
-	serverError.CheckFatal(err)
-
 	err = options.AddFlagsValues("certs", []string{"-c", "--cert"}, "GHFS_CERT", nil, "TLS certificate path")
 	serverError.CheckFatal(err)
 
@@ -291,7 +288,6 @@ func CmdResultsToParams(results []*goNixArgParser.ParseResult) (params Params, e
 		param.EmptyRoot = result.HasKey("emptyroot")
 		param.PrefixUrls, _ = result.GetStrings("prefixurls")
 		param.DefaultSort, _ = result.GetString("defaultsort")
-		param.UserMatchCase = result.HasKey("usermatchcase")
 		param.HostNames, _ = result.GetStrings("hostnames")
 		param.Theme, _ = result.GetString("theme")
 		param.ThemeDir, _ = result.GetString("themedir")
diff --git a/src/param/main.go b/src/param/main.go
@@ -56,13 +56,12 @@ type Param struct {
 	AuthUrls   []string
 	AuthDirs   []string
 	// value: [username, password]
-	UsersPlain    [][2]string
-	UsersBase64   [][2]string
-	UsersMd5      [][2]string
-	UsersSha1     [][2]string
-	UsersSha256   [][2]string
-	UsersSha512   [][2]string
-	UserMatchCase bool
+	UsersPlain  [][2]string
+	UsersBase64 [][2]string
+	UsersMd5    [][2]string
+	UsersSha1   [][2]string
+	UsersSha256 [][2]string
+	UsersSha512 [][2]string
 
 	Certificates []tls.Certificate
 	Listens      []string
diff --git a/src/serverHandler/vhostHandler.go b/src/serverHandler/vhostHandler.go
@@ -38,7 +38,7 @@ func NewVhostHandler(
 	theme theme.Theme,
 ) (handler http.Handler, errs []error) {
 	// users
-	users := user.NewList(p.UserMatchCase)
+	users := user.NewList()
 	for _, u := range p.UsersPlain {
 		errs = serverError.AppendError(errs, users.AddPlain(u[0], u[1]))
 	}
diff --git a/src/user/list.go b/src/user/list.go
@@ -2,12 +2,11 @@ package user
 
 import (
 	"errors"
-	"mjpclab.dev/ghfs/src/util"
+	"strings"
 )
 
 type List struct {
-	users          []user
-	namesEqualFunc util.StrEqualFunc
+	users []user
 }
 
 func (list *List) Len() int {
@@ -16,7 +15,7 @@ func (list *List) Len() int {
 
 func (list *List) FindIndex(username string) int {
 	for i := range list.users {
-		if list.namesEqualFunc(list.users[i].getName(), username) {
+		if strings.EqualFold(list.users[i].getName(), username) {
 			return i
 		}
 	}
@@ -95,12 +94,6 @@ func (list *List) Auth(username, password string) bool {
 	return list.users[index].auth(password)
 }
 
-func NewList(nameCaseSensitive bool) *List {
-	var namesEqualFunc util.StrEqualFunc
-	if nameCaseSensitive {
-		namesEqualFunc = util.IsStrEqualAccurate
-	} else {
-		namesEqualFunc = util.IsStrEqualNoCase
-	}
-	return &List{namesEqualFunc: namesEqualFunc}
+func NewList() *List {
+	return &List{}
 }
diff --git a/src/user/list_test.go b/src/user/list_test.go
@@ -4,168 +4,84 @@ import (
 	"testing"
 )
 
-var listAccurate *List
-var listNoCase *List
-
-func init() {
-	listAccurate = NewList(true)
-	listNoCase = NewList(false)
-}
+var list = NewList()
 
 func TestUserPlain(t *testing.T) {
-	// accurate
-	listAccurate.AddPlain("plain_user", "123")
-	if !listAccurate.Auth("plain_user", "123") {
-		t.Error()
-	}
-	if listAccurate.Auth("Plain_user", "123") {
+	list.AddPlain("plain_user", "123")
+	if !list.Auth("plain_user", "123") {
 		t.Error()
 	}
-	if listAccurate.Auth("plain_user", "12") {
+	if !list.Auth("Plain_User", "123") {
 		t.Error()
 	}
-
-	// no case
-	listNoCase.AddPlain("plain_user", "123")
-	if !listNoCase.Auth("plain_user", "123") {
-		t.Error()
-	}
-	if !listNoCase.Auth("Plain_User", "123") {
-		t.Error()
-	}
-	if listNoCase.Auth("plain_user", "12") {
+	if list.Auth("plain_user", "12") {
 		t.Error()
 	}
 }
 
 func TestUserBase64(t *testing.T) {
-	// accurate
-	listAccurate.AddBase64("base64_user", "MjM0")
-	if !listAccurate.Auth("base64_user", "234") {
-		t.Error()
-	}
-	if listAccurate.Auth("Base64_user", "234") {
+	list.AddBase64("base64_user", "MjM0")
+	if !list.Auth("base64_user", "234") {
 		t.Error()
 	}
-	if listAccurate.Auth("base64_user", "23") {
+	if !list.Auth("Base64_user", "234") {
 		t.Error()
 	}
-
-	// no case
-	listNoCase.AddBase64("base64_user", "MjM0")
-	if !listNoCase.Auth("base64_user", "234") {
-		t.Error()
-	}
-	if !listNoCase.Auth("Base64_user", "234") {
-		t.Error()
-	}
-	if listNoCase.Auth("base64_user", "23") {
+	if list.Auth("base64_user", "23") {
 		t.Error()
 	}
 
 }
 
 func TestUserMd5(t *testing.T) {
-	// accurate
-	listAccurate.AddMd5("md5_user", "d81f9c1be2e08964bf9f24b15f0e4900")
-	if !listAccurate.Auth("md5_user", "345") {
-		t.Error()
-	}
-	if listAccurate.Auth("Md5_user", "345") {
-		t.Error()
-	}
-	if listAccurate.Auth("md5_user", "34") {
-		t.Error()
-	}
-
-	// no case
-	listNoCase.AddMd5("md5_user", "d81f9c1be2e08964bf9f24b15f0e4900")
-	if !listNoCase.Auth("md5_user", "345") {
+	list.AddMd5("md5_user", "d81f9c1be2e08964bf9f24b15f0e4900")
+	if !list.Auth("md5_user", "345") {
 		t.Error()
 	}
-	if !listNoCase.Auth("Md5_user", "345") {
+	if !list.Auth("Md5_user", "345") {
 		t.Error()
 	}
-	if listNoCase.Auth("md5_user", "34") {
+	if list.Auth("md5_user", "34") {
 		t.Error()
 	}
 
 }
 
 func TestUserSha1(t *testing.T) {
-	// accurate
-	listAccurate.AddSha1("sha1_user", "51eac6b471a284d3341d8c0c63d0f1a286262a18")
-	if !listAccurate.Auth("sha1_user", "456") {
-		t.Error()
-	}
-	if listAccurate.Auth("Sha1_user", "456") {
+	list.AddSha1("sha1_user", "51eac6b471a284d3341d8c0c63d0f1a286262a18")
+	if !list.Auth("sha1_user", "456") {
 		t.Error()
 	}
-	if listAccurate.Auth("sha1_user", "45") {
-		t.Error()
-	}
-
-	// no case
-	listNoCase.AddSha1("sha1_user", "51eac6b471a284d3341d8c0c63d0f1a286262a18")
-	if !listNoCase.Auth("sha1_user", "456") {
+	if !list.Auth("Sha1_user", "456") {
 		t.Error()
 	}
-	if !listNoCase.Auth("Sha1_user", "456") {
-		t.Error()
-	}
-	if listNoCase.Auth("sha1_user", "45") {
+	if list.Auth("sha1_user", "45") {
 		t.Error()
 	}
 }
 
 func TestUserSha256(t *testing.T) {
-	// accurate
-	listAccurate.AddSha256("sha256_user", "97a6d21df7c51e8289ac1a8c026aaac143e15aa1957f54f42e30d8f8a85c3a55")
-	if !listAccurate.Auth("sha256_user", "567") {
-		t.Error()
-	}
-	if listAccurate.Auth("Sha256_user", "567") {
-		t.Error()
-	}
-	if listAccurate.Auth("sha256_user", "56") {
-		t.Error()
-	}
-
-	// no case
-	listNoCase.AddSha256("sha256_user", "97a6d21df7c51e8289ac1a8c026aaac143e15aa1957f54f42e30d8f8a85c3a55")
-	if !listNoCase.Auth("sha256_user", "567") {
+	list.AddSha256("sha256_user", "97a6d21df7c51e8289ac1a8c026aaac143e15aa1957f54f42e30d8f8a85c3a55")
+	if !list.Auth("sha256_user", "567") {
 		t.Error()
 	}
-	if !listNoCase.Auth("Sha256_user", "567") {
+	if !list.Auth("Sha256_user", "567") {
 		t.Error()
 	}
-	if listNoCase.Auth("sha256_user", "56") {
+	if list.Auth("sha256_user", "56") {
 		t.Error()
 	}
 }
 
 func TestUserSha512(t *testing.T) {
-	// accurate
-	listAccurate.AddSha512("sha512_user", "c7d57e5c0b0792b154d573089792d80f5b64d2bc0cf4d7d1f551a9e4a4966e925d06b253cc9662c01df76623fdfecb812a2a0604119cb1ac37c47e8027e94cb5")
-	if !listAccurate.Auth("sha512_user", "678") {
-		t.Error()
-	}
-	if listAccurate.Auth("Sha512_user", "678") {
-		t.Error()
-	}
-	if listAccurate.Auth("sha512_user", "67") {
-		t.Error()
-	}
-
-	// no case
-	listNoCase.AddSha512("sha512_user", "c7d57e5c0b0792b154d573089792d80f5b64d2bc0cf4d7d1f551a9e4a4966e925d06b253cc9662c01df76623fdfecb812a2a0604119cb1ac37c47e8027e94cb5")
-	if !listNoCase.Auth("sha512_user", "678") {
+	list.AddSha512("sha512_user", "c7d57e5c0b0792b154d573089792d80f5b64d2bc0cf4d7d1f551a9e4a4966e925d06b253cc9662c01df76623fdfecb812a2a0604119cb1ac37c47e8027e94cb5")
+	if !list.Auth("sha512_user", "678") {
 		t.Error()
 	}
-	if !listNoCase.Auth("Sha512_user", "678") {
+	if !list.Auth("Sha512_user", "678") {
 		t.Error()
 	}
-	if listNoCase.Auth("sha512_user", "67") {
+	if list.Auth("sha512_user", "67") {
 		t.Error()
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ func NewVhostHandler(`
`38`	`38`	`theme theme.Theme,`
`39`	`39`	`) (handler http.Handler, errs []error) {`
`40`	`40`	`// users`
`41`		`- users := user.NewList(p.UserMatchCase)`
	`41`	`+ users := user.NewList()`
`42`	`42`	`for _, u := range p.UsersPlain {`
`43`	`43`	`errs = serverError.AppendError(errs, users.AddPlain(u[0], u[1]))`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,12 +2,11 @@ package user`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"errors"`
`5`		`- "mjpclab.dev/ghfs/src/util"`
	`5`	`+ "strings"`
`6`	`6`	`)`
`7`	`7`
`8`	`8`	`type List struct {`
`9`		`- users []user`
`10`		`- namesEqualFunc util.StrEqualFunc`
	`9`	`+ users []user`
`11`	`10`	`}`
`12`	`11`
`13`	`12`	`func (list *List) Len() int {`
`@@ -16,7 +15,7 @@ func (list *List) Len() int {`
`16`	`15`
`17`	`16`	`func (list *List) FindIndex(username string) int {`
`18`	`17`	`for i := range list.users {`
`19`		`- if list.namesEqualFunc(list.users[i].getName(), username) {`
	`18`	`+ if strings.EqualFold(list.users[i].getName(), username) {`
`20`	`19`	`return i`
`21`	`20`	`}`
`22`	`21`	`}`
`@@ -95,12 +94,6 @@ func (list *List) Auth(username, password string) bool {`
`95`	`94`	`return list.users[index].auth(password)`
`96`	`95`	`}`
`97`	`96`
`98`		`-func NewList(nameCaseSensitive bool) *List {`
`99`		`- var namesEqualFunc util.StrEqualFunc`
`100`		`- if nameCaseSensitive {`
`101`		`- namesEqualFunc = util.IsStrEqualAccurate`
`102`		`- } else {`
`103`		`- namesEqualFunc = util.IsStrEqualNoCase`
`104`		`- }`
`105`		`- return &List{namesEqualFunc: namesEqualFunc}`
	`97`	`+func NewList() *List {`
	`98`	`+ return &List{}`
`106`	`99`	`}`