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	"gitbay":      true, // vanity go-import path on gitbay.org
20	"gitbay-bot":  true, // authors dependency-update issues
21	"healthz":     true,
22	"login":       true,
23	"logout":      true,
24	"new":         true,
25	"privacy":     true,
26	"raw":         true,
27	"register":    true,
28	"settings":    true,
29	"static":      true,
30}
31
32// namePat matches valid user, org, and repo names: lowercase alphanumerics,
33// dot, dash, underscore; must start with an alphanumeric. Dots are further
34// restricted by ValidateName to avoid "." / ".." and ".git" suffixes.
35var namePat = regexp.MustCompile(`^[a-z0-9][a-z0-9._-]{0,62}$`)
36
37// ValidateOwnerName checks a username or org name.
38func ValidateOwnerName(name string) error {
39	if err := ValidateName(name); err != nil {
40		return err
41	}
42	if reservedNames[name] {
43		return fmt.Errorf("name %q is reserved", name)
44	}
45	return nil
46}
47
48// ValidateName checks a repo name (reserved words are allowed for repos;
49// routes are namespaced under the owner).
50func ValidateName(name string) error {
51	if !namePat.MatchString(name) {
52		return fmt.Errorf("invalid name %q: lowercase letters, digits, '.', '-', '_' only; must start with a letter or digit; max 63 chars", name)
53	}
54	if name == "." || name == ".." {
55		return fmt.Errorf("invalid name %q", name)
56	}
57	if len(name) > 4 && name[len(name)-4:] == ".git" {
58		return fmt.Errorf("invalid name %q: must not end in .git", name)
59	}
60	if len(name) > 5 && name[len(name)-5:] == ".wiki" {
61		return fmt.Errorf("invalid name %q: .wiki names are reserved for wiki companion repositories", name)
62	}
63	return nil
64}
65
66// Reserved reports whether name is a reserved route word. Exported so the
67// httpd tests can assert route/reserved-list agreement.
68func Reserved(name string) bool { return reservedNames[name] }