- Notifications
You must be signed in to change notification settings - Fork913
feat(codersdk): export name validators#14550
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
3 changes: 1 addition & 2 deletionscli/usercreate.go
This file contains hidden or 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
3 changes: 1 addition & 2 deletionscoderd/externalauth/externalauth.go
This file contains hidden or 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
10 changes: 5 additions & 5 deletionscoderd/httpapi/httpapi.go
This file contains hidden or 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
2 changes: 1 addition & 1 deletioncoderd/httpapi/name.go
This file contains hidden or 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
10 changes: 5 additions & 5 deletionscoderd/userauth.go
This file contains hidden or 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
4 changes: 2 additions & 2 deletionscoderd/users.go
This file contains hidden or 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
125 changes: 125 additions & 0 deletionscodersdk/name.go
This file contains hidden or 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,125 @@ | ||
| package codersdk | ||
ethanndickson marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| import ( | ||
| "regexp" | ||
| "strings" | ||
| "github.com/moby/moby/pkg/namesgenerator" | ||
| "golang.org/x/xerrors" | ||
| ) | ||
| var ( | ||
| UsernameValidRegex = regexp.MustCompile("^[a-zA-Z0-9]+(?:-[a-zA-Z0-9]+)*$") | ||
| usernameReplace = regexp.MustCompile("[^a-zA-Z0-9-]*") | ||
| templateVersionName = regexp.MustCompile(`^[a-zA-Z0-9]+(?:[_.-]{1}[a-zA-Z0-9]+)*$`) | ||
| templateDisplayName = regexp.MustCompile(`^[^\s](.*[^\s])?$`) | ||
| ) | ||
| // UsernameFrom returns a best-effort username from the provided string. | ||
| // | ||
| // It first attempts to validate the incoming string, which will | ||
| // be returned if it is valid. It then will attempt to extract | ||
| // the username from an email address. If no success happens during | ||
| // these steps, a random username will be returned. | ||
| func UsernameFrom(str string) string { | ||
| if valid := NameValid(str); valid == nil { | ||
| return str | ||
| } | ||
| emailAt := strings.LastIndex(str, "@") | ||
| if emailAt >= 0 { | ||
| str = str[:emailAt] | ||
| } | ||
| str = usernameReplace.ReplaceAllString(str, "") | ||
| if valid := NameValid(str); valid == nil { | ||
| return str | ||
| } | ||
| return strings.ReplaceAll(namesgenerator.GetRandomName(1), "_", "-") | ||
| } | ||
| // NameValid returns whether the input string is a valid name. | ||
| // It is a generic validator for any name (user, workspace, template, role name, etc.). | ||
| func NameValid(str string) error { | ||
| if len(str) > 32 { | ||
| return xerrors.New("must be <= 32 characters") | ||
| } | ||
| if len(str) < 1 { | ||
| return xerrors.New("must be >= 1 character") | ||
| } | ||
| // Avoid conflicts with routes like /templates/new and /groups/create. | ||
| if str == "new" || str == "create" { | ||
| return xerrors.Errorf("cannot use %q as a name", str) | ||
| } | ||
| matched := UsernameValidRegex.MatchString(str) | ||
| if !matched { | ||
| return xerrors.New("must be alphanumeric with hyphens") | ||
| } | ||
| return nil | ||
| } | ||
| // TemplateVersionNameValid returns whether the input string is a valid template version name. | ||
| func TemplateVersionNameValid(str string) error { | ||
| if len(str) > 64 { | ||
| return xerrors.New("must be <= 64 characters") | ||
| } | ||
| matched := templateVersionName.MatchString(str) | ||
| if !matched { | ||
| return xerrors.New("must be alphanumeric with underscores and dots") | ||
| } | ||
| return nil | ||
| } | ||
| // DisplayNameValid returns whether the input string is a valid template display name. | ||
| func DisplayNameValid(str string) error { | ||
| if len(str) == 0 { | ||
| return nil // empty display_name is correct | ||
| } | ||
| if len(str) > 64 { | ||
| return xerrors.New("must be <= 64 characters") | ||
| } | ||
| matched := templateDisplayName.MatchString(str) | ||
| if !matched { | ||
| return xerrors.New("must be alphanumeric with spaces") | ||
| } | ||
| return nil | ||
| } | ||
| // UserRealNameValid returns whether the input string is a valid real user name. | ||
| func UserRealNameValid(str string) error { | ||
| if len(str) > 128 { | ||
| return xerrors.New("must be <= 128 characters") | ||
| } | ||
| if strings.TrimSpace(str) != str { | ||
| return xerrors.New("must not have leading or trailing whitespace") | ||
| } | ||
| return nil | ||
| } | ||
| // GroupNameValid returns whether the input string is a valid group name. | ||
| func GroupNameValid(str string) error { | ||
| // 36 is to support using UUIDs as the group name. | ||
| if len(str) > 36 { | ||
| return xerrors.New("must be <= 36 characters") | ||
| } | ||
| // Avoid conflicts with routes like /groups/new and /groups/create. | ||
| if str == "new" || str == "create" { | ||
| return xerrors.Errorf("cannot use %q as a name", str) | ||
| } | ||
| matched := UsernameValidRegex.MatchString(str) | ||
| if !matched { | ||
| return xerrors.New("must be alphanumeric with hyphens") | ||
| } | ||
| return nil | ||
| } | ||
| // NormalizeUserRealName normalizes a user name such that it will pass | ||
| // validation by UserRealNameValid. This is done to avoid blocking | ||
| // little Bobby Whitespace from using Coder. | ||
| func NormalizeRealUsername(str string) string { | ||
| s := strings.TrimSpace(str) | ||
| if len(s) > 128 { | ||
| s = s[:128] | ||
| } | ||
| return s | ||
| } | ||
22 changes: 11 additions & 11 deletionscoderd/httpapi/name_test.go → codersdk/name_test.go
This file contains hidden or 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
2 changes: 1 addition & 1 deletionenterprise/coderd/roles.go
This file contains hidden or 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
4 changes: 2 additions & 2 deletionsenterprise/coderd/scim.go
This file contains hidden or 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
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.