internal/httpd/routes.go
229 lines · 12286 bytes
1package httpd
2
3import (
4 "fmt"
5 "net"
6 "net/http"
7 "strings"
8)
9
10// Route is one entry in the explicit route table. The view-only guarantee is
11// structural: Handler() consults web.mode when building the table, and the
12// route test asserts no mutating route exists in view_only mode.
13type Route struct {
14 Method string
15 Pattern string // without method prefix
16 // Mutating marks routes that can change server state. The git transport
17 // POSTs are not mutating: upload-pack is a pure read, and the
18 // receive-pack endpoint is a static refusal that writes nothing.
19 Mutating bool
20 Handler http.HandlerFunc
21}
22
23// Routes returns the route table for the configured web.mode.
24func (s *Server) Routes() []Route {
25 // Git smart transport (anonymous, public repos only).
26 routes := []Route{
27 {Method: "GET", Pattern: "/{owner}/{repo}/info/refs", Handler: s.infoRefs},
28 {Method: "POST", Pattern: "/{owner}/{repo}/git-upload-pack", Handler: s.uploadPack},
29 {Method: "POST", Pattern: "/{owner}/{repo}/git-receive-pack", Handler: s.receivePackRefusal},
30 // Git LFS: token-authenticated transport (minted over SSH), not
31 // web-session routes — anonymous download for public repos only.
32 {Method: "POST", Pattern: "/{owner}/{repo}/info/lfs/objects/batch", Handler: s.lfsBatch},
33 {Method: "GET", Pattern: "/{owner}/{repo}/info/lfs/objects/{oid}", Handler: s.lfsDownload},
34 {Method: "PUT", Pattern: "/{owner}/{repo}/info/lfs/objects/{oid}", Handler: s.lfsUpload},
35 }
36
37 // Web UI, read-only. These exist in every mode.
38 routes = append(routes,
39 Route{Method: "GET", Pattern: "/{$}", Handler: s.index},
40 Route{Method: "GET", Pattern: "/explore", Handler: s.explore},
41 Route{Method: "GET", Pattern: "/healthz", Handler: s.healthz},
42 Route{Method: "GET", Pattern: "/privacy", Handler: s.privacy},
43 Route{Method: "GET", Pattern: "/static/style.css", Handler: s.stylesheet},
44 // Literal per-file routes: a {name} wildcard is ambiguous against
45 // /{owner}/{repo}/... patterns in ServeMux precedence.
46 Route{Method: "GET", Pattern: "/static/fonts/plex-sans.woff2", Handler: s.font},
47 Route{Method: "GET", Pattern: "/static/fonts/plex-mono-400.woff2", Handler: s.font},
48 Route{Method: "GET", Pattern: "/static/fonts/plex-mono-500.woff2", Handler: s.font},
49 Route{Method: "GET", Pattern: "/favicon.svg", Handler: s.favicon},
50 Route{Method: "GET", Pattern: "/{owner}", Handler: s.ownerPage},
51 Route{Method: "GET", Pattern: "/{owner}/{repo}", Handler: s.repoHome},
52 Route{Method: "GET", Pattern: "/{owner}/{repo}/tree/{ref}/{path...}", Handler: s.tree},
53 Route{Method: "GET", Pattern: "/{owner}/{repo}/blob/{ref}/{path...}", Handler: s.blob},
54 Route{Method: "GET", Pattern: "/{owner}/{repo}/blame/{ref}/{path...}", Handler: s.blame},
55 Route{Method: "GET", Pattern: "/{owner}/{repo}/search", Handler: s.search},
56 Route{Method: "GET", Pattern: "/{owner}/{repo}/milestones", Handler: s.milestones},
57 Route{Method: "GET", Pattern: "/{owner}/{repo}/wiki", Handler: s.wiki},
58 Route{Method: "GET", Pattern: "/{owner}/{repo}/wiki/_raw/{path...}", Handler: s.wikiRaw},
59 Route{Method: "GET", Pattern: "/{owner}/{repo}/wiki/{page}", Handler: s.wiki},
60 Route{Method: "GET", Pattern: "/{owner}/{repo}/releases", Handler: s.releases},
61 Route{Method: "GET", Pattern: "/{owner}/{repo}/builds", Handler: s.builds},
62 Route{Method: "GET", Pattern: "/{owner}/{repo}/badge/build.svg", Handler: s.buildBadge},
63 Route{Method: "GET", Pattern: "/{owner}/{repo}/badge/build.png", Handler: s.buildBadgePNG},
64 Route{Method: "GET", Pattern: "/{owner}/{repo}/builds/{n}", Handler: s.build},
65 Route{Method: "GET", Pattern: "/{owner}/{repo}/releases/download/{tag}/{name}", Handler: s.releaseAsset},
66 Route{Method: "GET", Pattern: "/{owner}/{repo}/raw/{ref}/{path...}", Handler: s.raw},
67 Route{Method: "GET", Pattern: "/{owner}/{repo}/log", Handler: s.log},
68 Route{Method: "GET", Pattern: "/{owner}/{repo}/log/{ref}", Handler: s.log},
69 Route{Method: "GET", Pattern: "/{owner}/{repo}/commit/{sha}", Handler: s.commit},
70 Route{Method: "GET", Pattern: "/{owner}/{repo}/refs", Handler: s.refs},
71 Route{Method: "GET", Pattern: "/{owner}/{repo}/archive/{file}", Handler: s.archive},
72 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues", Handler: s.issues},
73 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues/{n}", Handler: s.issue},
74 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs", Handler: s.mrs},
75 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs/{n}", Handler: s.mr},
76 )
77
78 // The JSON API is its own opt-in surface, independent of web.mode.
79 if s.cfg.API.Enabled {
80 routes = append(routes,
81 Route{Method: "POST", Pattern: "/api/v1/cmd", Mutating: true, Handler: s.apiCmd},
82 Route{Method: "GET", Pattern: "/api/v1/read", Handler: s.apiRead},
83 )
84 }
85
86 // Account-mode routes exist only when web.mode = "accounts". In
87 // view_only they are never registered — the structural guarantee.
88 if s.cfg.Web.Mode == "accounts" {
89 routes = append(routes,
90 Route{Method: "GET", Pattern: "/login", Handler: s.login, Mutating: true}, // consumes a one-time token
91 Route{Method: "POST", Pattern: "/logout", Mutating: true,
92 Handler: s.checkOrigin(s.logout)},
93 Route{Method: "GET", Pattern: "/new", Handler: s.requireUser(s.newRepoForm)},
94 Route{Method: "GET", Pattern: "/settings", Handler: s.requireUser(s.accountForm)},
95 Route{Method: "GET", Pattern: "/admin", Handler: s.requireUser(s.adminPage)},
96 Route{Method: "POST", Pattern: "/{owner}", Mutating: true,
97 Handler: s.checkOrigin(s.requireUser(s.orgSubmit))},
98 Route{Method: "POST", Pattern: "/settings", Mutating: true,
99 Handler: s.checkOrigin(s.requireUser(s.accountSubmit))},
100 )
101 // Web signup fronts the same registration path as SSH register,
102 // so it exists only when registration is open or invite.
103 if s.cfg.Registration.Mode != "closed" {
104 routes = append(routes,
105 Route{Method: "GET", Pattern: "/register", Handler: s.signupForm},
106 Route{Method: "POST", Pattern: "/register", Mutating: true,
107 Handler: s.checkOrigin(s.signupSubmit)},
108 )
109 }
110 routes = append(routes,
111 Route{Method: "POST", Pattern: "/new", Mutating: true,
112 Handler: s.checkOrigin(s.requireUser(s.newRepoSubmit))},
113 Route{Method: "POST", Pattern: "/{owner}/{repo}/pin", Mutating: true,
114 Handler: s.checkOrigin(s.requireUser(s.pinToggle))},
115 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues/new",
116 Handler: s.requireUser(s.issueCreateForm)},
117 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/new", Mutating: true,
118 Handler: s.checkOrigin(s.requireUser(s.issueCreateSubmit))},
119 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/comment", Mutating: true,
120 Handler: s.checkOrigin(s.requireUser(s.issueCommentSubmit))},
121 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/edit", Mutating: true,
122 Handler: s.checkOrigin(s.requireUser(s.issueEditSubmit))},
123 // Triage: each runs the matching issue command.
124 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/state", Mutating: true,
125 Handler: s.checkOrigin(s.requireUser(s.issueStateSubmit))},
126 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/label", Mutating: true,
127 Handler: s.checkOrigin(s.requireUser(s.issueLabelSubmit))},
128 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/assign", Mutating: true,
129 Handler: s.checkOrigin(s.requireUser(s.issueAssignSubmit))},
130 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/milestone", Mutating: true,
131 Handler: s.checkOrigin(s.requireUser(s.issueMilestoneSubmit))},
132 Route{Method: "POST", Pattern: "/{owner}/{repo}/releases", Mutating: true,
133 Handler: s.checkOrigin(s.requireUser(s.releaseSubmit))},
134 Route{Method: "POST", Pattern: "/{owner}/{repo}/builds", Mutating: true,
135 Handler: s.checkOrigin(s.requireUser(s.buildTriggerSubmit))},
136 Route{Method: "GET", Pattern: "/{owner}/{repo}/settings",
137 Handler: s.requireUser(s.settingsForm)},
138 Route{Method: "POST", Pattern: "/{owner}/{repo}/settings", Mutating: true,
139 Handler: s.checkOrigin(s.requireUser(s.settingsSubmit))},
140 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs/new",
141 Handler: s.requireUser(s.mrCreateForm)},
142 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/new", Mutating: true,
143 Handler: s.checkOrigin(s.requireUser(s.mrCreateSubmit))},
144 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/edit", Mutating: true,
145 Handler: s.checkOrigin(s.requireUser(s.mrEditSubmit))},
146 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/comment", Mutating: true,
147 Handler: s.checkOrigin(s.requireUser(s.mrCommentSubmit))},
148 // Review loop: each runs the matching mr command.
149 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/review", Mutating: true,
150 Handler: s.checkOrigin(s.requireUser(s.mrReviewSubmit))},
151 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/merge", Mutating: true,
152 Handler: s.checkOrigin(s.requireUser(s.mrMergeSubmit))},
153 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/close", Mutating: true,
154 Handler: s.checkOrigin(s.requireUser(s.mrCloseSubmit))},
155 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/retarget", Mutating: true,
156 Handler: s.checkOrigin(s.requireUser(s.mrRetargetSubmit))},
157 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/thread", Mutating: true,
158 Handler: s.checkOrigin(s.requireUser(s.mrThreadSubmit))},
159 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/diff-comment", Mutating: true,
160 Handler: s.checkOrigin(s.requireUser(s.mrDiffCommentSubmit))},
161 Route{Method: "GET", Pattern: "/{owner}/{repo}/edit/{ref}/{path...}",
162 Handler: s.requireUser(s.editForm)},
163 Route{Method: "POST", Pattern: "/{owner}/{repo}/edit/{ref}/{path...}", Mutating: true,
164 Handler: s.checkOrigin(s.requireUser(s.editSubmit))},
165 )
166 }
167 return routes
168}
169
170func (s *Server) Handler() http.Handler {
171 mux := http.NewServeMux()
172 for _, r := range s.Routes() {
173 mux.HandleFunc(r.Method+" "+r.Pattern, r.Handler)
174 }
175 var h http.Handler = mux
176 if len(s.cfg.GoImport) > 0 {
177 h = s.goImportHandler(mux)
178 }
179 // Always wrapped: custom pages domains work with or without the
180 // built-in [pages] domain.
181 return s.pagesRouter(s.securityHeaders(h))
182}
183
184// securityHeaders sets defensive response headers on every reply. The CSP
185// is strict where it can be: no scripts at all (the UI needs none), no
186// plugins, no embedding. Inline styles are allowed because label chips
187// carry their color inline (chroma is class-based so the syntax palette
188// can follow the color scheme). Images may load from anywhere so external README images
189// still render; they are the one thing a reader-facing forge can't police
190// without a proxy.
191func (s *Server) securityHeaders(next http.Handler) http.Handler {
192 const csp = "default-src 'self'; script-src 'none'; style-src 'self' 'unsafe-inline'; " +
193 "img-src * data:; object-src 'none'; base-uri 'none'; form-action 'self'; frame-ancestors 'none'"
194 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
195 hd := w.Header()
196 hd.Set("Content-Security-Policy", csp)
197 hd.Set("X-Frame-Options", "DENY")
198 hd.Set("X-Content-Type-Options", "nosniff")
199 hd.Set("Referrer-Policy", "no-referrer")
200 hd.Set("Cross-Origin-Opener-Policy", "same-origin")
201 if s.cfg.HTTP.TLS != "off" {
202 hd.Set("Strict-Transport-Security", "max-age=31536000; includeSubDomains")
203 }
204 next.ServeHTTP(w, r)
205 })
206}
207
208func (s *Server) goImportHandler(mux http.Handler) http.Handler {
209 // Vanity Go modules: ?go-get=1 requests under a configured module
210 // path answer with the go-import meta tag before normal routing.
211 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
212 if r.URL.Query().Get("go-get") == "1" {
213 host := r.Host
214 if h, _, err := net.SplitHostPort(host); err == nil {
215 host = h
216 }
217 requested := host + strings.TrimSuffix(r.URL.Path, "/")
218 for module, repo := range s.cfg.GoImport {
219 if requested == module || strings.HasPrefix(requested, module+"/") {
220 w.Header().Set("Content-Type", "text/html; charset=utf-8")
221 fmt.Fprintf(w, `<!DOCTYPE html><html><head><meta name="go-import" content="%s git %s/%s.git"></head><body>%s</body></html>`,
222 module, s.cfg.Server.SiteURL, repo, module)
223 return
224 }
225 }
226 }
227 mux.ServeHTTP(w, r)
228 })
229}