internal/policy/names.go

 1// Package policy holds access-control and naming rules.
 2package policy
 3
 4import (
 5	"fmt"
 6	"regexp"
 7)
 8
 9// reservedNames are forbidden as usernames and org names because they are, or
10// will be, top-level web routes (the UI serves /<owner>/<name>). Any change to
11// the httpd mux's top-level routes must be reflected here; the httpd package
12// asserts this in its tests.
13var reservedNames = map[string]bool{
14	"admin":       true,
15	"api":         true,
16	"archive":     true,
17	"explore":     true,
18	"favicon.svg": true,
19	"login":       true,
20	"logout":      true,
21	"new":         true,
22	"raw":         true,
23	"register":    true,
24	"settings":    true,
25	"static":      true,
26}
27
28// namePat matches valid user, org, and repo names: lowercase alphanumerics,
29// dot, dash, underscore; must start with an alphanumeric. Dots are further
30// restricted by ValidateName to avoid "." / ".." and ".git" suffixes.
31var namePat = regexp.MustCompile(`^[a-z0-9][a-z0-9._-]{0,62}$`)
32
33// ValidateOwnerName checks a username or org name.
34func ValidateOwnerName(name string) error {
35	if err := ValidateName(name); err != nil {
36		return err
37	}
38	if reservedNames[name] {
39		return fmt.Errorf("name %q is reserved", name)
40	}
41	return nil
42}
43
44// ValidateName checks a repo name (reserved words are allowed for repos;
45// routes are namespaced under the owner).
46func ValidateName(name string) error {
47	if !namePat.MatchString(name) {
48		return fmt.Errorf("invalid name %q: lowercase letters, digits, '.', '-', '_' only; must start with a letter or digit; max 63 chars", name)
49	}
50	if name == "." || name == ".." {
51		return fmt.Errorf("invalid name %q", name)
52	}
53	if len(name) > 4 && name[len(name)-4:] == ".git" {
54		return fmt.Errorf("invalid name %q: must not end in .git", name)
55	}
56	return nil
57}
58
59// Reserved reports whether name is a reserved route word. Exported so the
60// httpd tests can assert route/reserved-list agreement.
61func Reserved(name string) bool { return reservedNames[name] }