internal/httpd/routes.go
346 lines · 19581 bytes
1package httpd
2
3import (
4 "fmt"
5 "io/fs"
6 "net"
7 "net/http"
8 "strings"
9
10 "gitbay.org/gitbay/internal/web"
11)
12
13// Route is one entry in the explicit route table. The view-only guarantee is
14// structural: Handler() consults web.mode when building the table, and the
15// route test asserts no mutating route exists in view_only mode.
16type Route struct {
17 Method string
18 Pattern string // without method prefix
19 // Mutating marks routes that can change server state. The git transport
20 // POSTs are not mutating: upload-pack is a pure read, and the
21 // receive-pack endpoint is a static refusal that writes nothing.
22 Mutating bool
23 Handler http.HandlerFunc
24}
25
26// Routes returns the route table for the configured web.mode.
27func (s *Server) Routes() []Route {
28 // Git smart transport (anonymous, public repos only).
29 routes := []Route{
30 {Method: "GET", Pattern: "/{owner}/{repo}/info/refs", Handler: s.infoRefs},
31 {Method: "POST", Pattern: "/{owner}/{repo}/git-upload-pack", Handler: s.uploadPack},
32 {Method: "POST", Pattern: "/{owner}/{repo}/git-receive-pack", Handler: s.receivePackRefusal},
33 // Git LFS: token-authenticated transport (minted over SSH), not
34 // web-session routes — anonymous download for public repos only.
35 {Method: "POST", Pattern: "/{owner}/{repo}/info/lfs/objects/batch", Handler: s.lfsBatch},
36 {Method: "GET", Pattern: "/{owner}/{repo}/info/lfs/objects/{oid}", Handler: s.lfsDownload},
37 {Method: "PUT", Pattern: "/{owner}/{repo}/info/lfs/objects/{oid}", Handler: s.lfsUpload},
38 }
39
40 // Web UI, read-only. These exist in every mode.
41 routes = append(routes,
42 Route{Method: "GET", Pattern: "/{$}", Handler: s.index},
43 Route{Method: "GET", Pattern: "/explore", Handler: s.explore},
44 Route{Method: "GET", Pattern: "/search", Handler: s.globalSearch},
45 Route{Method: "GET", Pattern: "/healthz", Handler: s.healthz},
46 Route{Method: "GET", Pattern: "/privacy", Handler: s.privacy},
47 Route{Method: "GET", Pattern: "/static/style.css", Handler: s.stylesheet},
48 )
49 // One literal route per embedded font file: a {name} wildcard is
50 // ambiguous against /{owner}/{repo}/... patterns in ServeMux precedence,
51 // and hand-typed names drifted from the files once (#102).
52 fonts, _ := fs.ReadDir(web.FontFS, "static/fonts")
53 for _, f := range fonts {
54 routes = append(routes, Route{Method: "GET", Pattern: "/static/fonts/" + f.Name(), Handler: s.font})
55 }
56 images, _ := fs.ReadDir(web.ImageFS, "static/img")
57 for _, f := range images {
58 routes = append(routes, Route{Method: "GET", Pattern: "/static/img/" + f.Name(), Handler: s.image})
59 }
60 routes = append(routes,
61 Route{Method: "GET", Pattern: "/favicon.svg", Handler: s.favicon},
62 Route{Method: "GET", Pattern: "/{owner}", Handler: s.ownerProfile},
63 Route{Method: "GET", Pattern: "/{owner}/{repo}", Handler: s.repoHome},
64 Route{Method: "GET", Pattern: "/{owner}/{repo}/tree/{ref}/{path...}", Handler: s.tree},
65 Route{Method: "GET", Pattern: "/{owner}/{repo}/blob/{ref}/{path...}", Handler: s.blob},
66 Route{Method: "GET", Pattern: "/{owner}/{repo}/blame/{ref}/{path...}", Handler: s.blame},
67 Route{Method: "GET", Pattern: "/{owner}/{repo}/search", Handler: s.search},
68 Route{Method: "GET", Pattern: "/{owner}/{repo}/symbols", Handler: s.symbolsPage},
69 Route{Method: "GET", Pattern: "/{owner}/{repo}/milestones", Handler: s.milestones},
70 Route{Method: "GET", Pattern: "/{owner}/{repo}/labels", Handler: s.labels},
71 Route{Method: "GET", Pattern: "/{owner}/{repo}/wiki", Handler: s.wiki},
72 Route{Method: "GET", Pattern: "/{owner}/{repo}/wiki/_raw/{path...}", Handler: s.wikiRaw},
73 Route{Method: "GET", Pattern: "/{owner}/{repo}/wiki/{page...}", Handler: s.wiki},
74 Route{Method: "GET", Pattern: "/{owner}/{repo}/releases", Handler: s.releases},
75 Route{Method: "GET", Pattern: "/{owner}/{repo}/releases.atom", Handler: s.releasesAtom},
76 Route{Method: "GET", Pattern: "/{owner}/{repo}/log.atom", Handler: s.logAtom},
77 Route{Method: "GET", Pattern: "/{owner}/{repo}/log.atom/{ref...}", Handler: s.logAtom},
78 Route{Method: "GET", Pattern: "/{owner}/activity.atom", Handler: s.ownerAtom},
79 Route{Method: "GET", Pattern: "/{owner}/-/repositories", Handler: s.ownerProfile},
80 Route{Method: "GET", Pattern: "/{owner}/-/bookmarks", Handler: s.ownerProfile},
81 Route{Method: "GET", Pattern: "/{owner}/-/people", Handler: s.ownerProfile},
82 Route{Method: "GET", Pattern: "/{owner}/-/labels", Handler: s.orgLabels},
83 Route{Method: "GET", Pattern: "/{owner}/-/milestones", Handler: s.orgMilestones},
84 Route{Method: "GET", Pattern: "/{owner}/-/snippets", Handler: s.ownerProfile},
85 Route{Method: "GET", Pattern: "/{owner}/-/snippets/{id}", Handler: s.snippetPage},
86 Route{Method: "GET", Pattern: "/{owner}/-/snippets/{id}/raw/{name}", Handler: s.snippetRaw},
87 Route{Method: "GET", Pattern: "/{owner}/{repo}/builds", Handler: s.builds},
88 Route{Method: "GET", Pattern: "/{owner}/{repo}/badge/build.svg", Handler: s.buildBadge},
89 Route{Method: "GET", Pattern: "/{owner}/{repo}/badge/build.png", Handler: s.buildBadgePNG},
90 Route{Method: "GET", Pattern: "/{owner}/{repo}/builds/{n}", Handler: s.build},
91 Route{Method: "GET", Pattern: "/{owner}/{repo}/releases/download/{tag}/{name}", Handler: s.releaseAsset},
92 Route{Method: "GET", Pattern: "/{owner}/{repo}/raw/{ref}/{path...}", Handler: s.raw},
93 Route{Method: "GET", Pattern: "/{owner}/{repo}/log", Handler: s.log},
94 Route{Method: "GET", Pattern: "/{owner}/{repo}/log/{ref}", Handler: s.log},
95 Route{Method: "GET", Pattern: "/{owner}/{repo}/commit/{sha}", Handler: s.commit},
96 Route{Method: "GET", Pattern: "/{owner}/{repo}/compare", Handler: s.compare},
97 Route{Method: "GET", Pattern: "/{owner}/{repo}/compare/{range}", Handler: s.compare},
98 Route{Method: "GET", Pattern: "/{owner}/{repo}/refs", Handler: s.refs},
99 Route{Method: "GET", Pattern: "/{owner}/{repo}/archive/{file}", Handler: s.archive},
100 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues", Handler: s.issues},
101 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues/{n}", Handler: s.issue},
102 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs", Handler: s.mrs},
103 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs/{n}", Handler: s.mr},
104 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs/{n}/range-diff", Handler: s.mrRangeDiff},
105 )
106
107 // The JSON API is its own opt-in surface, independent of web.mode.
108 if s.cfg.API.Enabled {
109 routes = append(routes,
110 Route{Method: "POST", Pattern: "/api/v1/cmd", Mutating: true, Handler: s.apiCmd},
111 Route{Method: "GET", Pattern: "/api/v1/read", Handler: s.apiRead},
112 )
113 }
114
115 // Account-mode routes exist only when web.mode = "accounts". In
116 // view_only they are never registered — the structural guarantee.
117 if s.cfg.Web.Mode == "accounts" {
118 routes = append(routes,
119 Route{Method: "GET", Pattern: "/login", Handler: s.login, Mutating: true}, // consumes a one-time token
120 Route{Method: "POST", Pattern: "/login", Mutating: true,
121 Handler: s.checkOrigin(s.loginSubmit)},
122 Route{Method: "GET", Pattern: "/logout", Handler: s.requireUser(s.logoutForm)},
123 Route{Method: "POST", Pattern: "/logout", Mutating: true,
124 Handler: s.checkOrigin(s.logout)},
125 Route{Method: "GET", Pattern: "/new", Handler: s.requireUser(s.newRepoForm)},
126 Route{Method: "GET", Pattern: "/settings", Handler: s.requireUser(s.accountForm)},
127 Route{Method: "GET", Pattern: "/settings/export", Handler: s.requireUser(s.accountExport)},
128 Route{Method: "GET", Pattern: "/notifications", Handler: s.requireUser(s.notifications)},
129 Route{Method: "POST", Pattern: "/notifications", Mutating: true,
130 Handler: s.checkOrigin(s.requireUser(s.notificationsRead))},
131 Route{Method: "GET", Pattern: "/admin", Handler: s.requireUser(s.adminPage)},
132 Route{Method: "GET", Pattern: "/admin/users", Handler: s.requireUser(s.adminUsers)},
133 Route{Method: "POST", Pattern: "/admin/users", Mutating: true,
134 Handler: s.checkOrigin(s.requireUser(s.adminUsersSubmit))},
135 Route{Method: "POST", Pattern: "/{owner}", Mutating: true,
136 Handler: s.checkOrigin(s.requireUser(s.orgSubmit))},
137 Route{Method: "POST", Pattern: "/settings", Mutating: true,
138 Handler: s.checkOrigin(s.requireUser(s.accountSubmit))},
139 )
140 // Web signup fronts the same registration path as SSH register,
141 // so it exists only when registration is open or invite.
142 if s.cfg.Registration.Mode != "closed" {
143 routes = append(routes,
144 Route{Method: "GET", Pattern: "/register", Handler: s.signupForm},
145 Route{Method: "POST", Pattern: "/register", Mutating: true,
146 Handler: s.checkOrigin(s.signupSubmit)},
147 )
148 }
149 routes = append(routes,
150 Route{Method: "POST", Pattern: "/new", Mutating: true,
151 Handler: s.checkOrigin(s.requireUser(s.newSubmit))},
152 Route{Method: "POST", Pattern: "/{owner}/{repo}/pin", Mutating: true,
153 Handler: s.checkOrigin(s.requireUser(s.pinToggle))},
154 Route{Method: "POST", Pattern: "/{owner}/{repo}/watch", Mutating: true,
155 Handler: s.checkOrigin(s.requireUser(s.watchToggle))},
156 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues/new",
157 Handler: s.requireUser(s.issueCreateForm)},
158 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/new", Mutating: true,
159 Handler: s.checkOrigin(s.requireUser(s.issueCreateSubmit))},
160 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/comment", Mutating: true,
161 Handler: s.checkOrigin(s.requireUser(s.issueCommentSubmit))},
162 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/edit", Mutating: true,
163 Handler: s.checkOrigin(s.requireUser(s.issueEditSubmit))},
164 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/react", Mutating: true,
165 Handler: s.checkOrigin(s.requireUser(s.issueReactSubmit))},
166 // Triage: each runs the matching issue command.
167 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/state", Mutating: true,
168 Handler: s.checkOrigin(s.requireUser(s.issueStateSubmit))},
169 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/label", Mutating: true,
170 Handler: s.checkOrigin(s.requireUser(s.issueLabelSubmit))},
171 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/assign", Mutating: true,
172 Handler: s.checkOrigin(s.requireUser(s.issueAssignSubmit))},
173 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/milestone", Mutating: true,
174 Handler: s.checkOrigin(s.requireUser(s.issueMilestoneSubmit))},
175 Route{Method: "POST", Pattern: "/{owner}/{repo}/releases", Mutating: true,
176 Handler: s.checkOrigin(s.requireUser(s.releaseSubmit))},
177 Route{Method: "POST", Pattern: "/{owner}/{repo}/labels", Mutating: true,
178 Handler: s.checkOrigin(s.requireUser(s.labelSubmit))},
179 Route{Method: "POST", Pattern: "/{owner}/{repo}/releases/assets", Mutating: true,
180 Handler: s.checkOrigin(s.requireUser(s.releaseAssetSubmit))},
181 Route{Method: "POST", Pattern: "/{owner}/{repo}/milestones", Mutating: true,
182 Handler: s.checkOrigin(s.requireUser(s.milestoneSubmit))},
183 Route{Method: "POST", Pattern: "/{owner}/-/labels", Mutating: true,
184 Handler: s.checkOrigin(s.requireUser(s.orgLabelSubmit))},
185 Route{Method: "POST", Pattern: "/{owner}/-/milestones", Mutating: true,
186 Handler: s.checkOrigin(s.requireUser(s.orgMilestoneSubmit))},
187 Route{Method: "GET", Pattern: "/bookmarks", Handler: s.requireUser(s.bookmarksPage)},
188 Route{Method: "GET", Pattern: "/{owner}/-/queries", Handler: s.requireUser(s.queriesPage)},
189 Route{Method: "GET", Pattern: "/{owner}/-/queries/{name}", Handler: s.requireUser(s.queriesPage)},
190 Route{Method: "GET", Pattern: "/{owner}/-/snippets/new", Handler: s.requireUser(s.snippetNewForm)},
191 Route{Method: "POST", Pattern: "/{owner}/-/snippets/new", Mutating: true,
192 Handler: s.checkOrigin(s.requireUser(s.snippetNewSubmit))},
193 Route{Method: "POST", Pattern: "/{owner}/-/snippets/{id}/edit", Mutating: true,
194 Handler: s.checkOrigin(s.requireUser(s.snippetEditSubmit))},
195 Route{Method: "POST", Pattern: "/{owner}/-/snippets/{id}/delete", Mutating: true,
196 Handler: s.checkOrigin(s.requireUser(s.snippetDeleteSubmit))},
197 Route{Method: "POST", Pattern: "/{owner}/-/snippets/{id}/file", Mutating: true,
198 Handler: s.checkOrigin(s.requireUser(s.snippetFileSubmit))},
199 Route{Method: "POST", Pattern: "/{owner}/-/snippets/{id}/file/remove", Mutating: true,
200 Handler: s.checkOrigin(s.requireUser(s.snippetFileRemoveSubmit))},
201 Route{Method: "POST", Pattern: "/{owner}/{repo}/bookmark", Mutating: true,
202 Handler: s.checkOrigin(s.requireUser(s.bookmarkToggle))},
203 Route{Method: "GET", Pattern: "/{owner}/{repo}/fork", Handler: s.requireUser(s.forkForm)},
204 Route{Method: "POST", Pattern: "/{owner}/{repo}/fork", Mutating: true,
205 Handler: s.checkOrigin(s.requireUser(s.forkSubmit))},
206 Route{Method: "POST", Pattern: "/{owner}/{repo}/builds", Mutating: true,
207 Handler: s.checkOrigin(s.requireUser(s.buildTriggerSubmit))},
208 Route{Method: "POST", Pattern: "/{owner}/{repo}/builds/{n}/cancel", Mutating: true,
209 Handler: s.checkOrigin(s.requireUser(s.buildCancelSubmit))},
210 Route{Method: "GET", Pattern: "/{owner}/{repo}/settings",
211 Handler: s.requireUser(s.settingsForm)},
212 Route{Method: "POST", Pattern: "/{owner}/{repo}/settings", Mutating: true,
213 Handler: s.checkOrigin(s.requireUser(s.settingsSubmit))},
214 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs/new",
215 Handler: s.requireUser(s.mrCreateForm)},
216 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/new", Mutating: true,
217 Handler: s.checkOrigin(s.requireUser(s.mrCreateSubmit))},
218 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/edit", Mutating: true,
219 Handler: s.checkOrigin(s.requireUser(s.mrEditSubmit))},
220 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/comment", Mutating: true,
221 Handler: s.checkOrigin(s.requireUser(s.mrCommentSubmit))},
222 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/react", Mutating: true,
223 Handler: s.checkOrigin(s.requireUser(s.mrReactSubmit))},
224 // Review loop: each runs the matching mr command.
225 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/review", Mutating: true,
226 Handler: s.checkOrigin(s.requireUser(s.mrReviewSubmit))},
227 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/review-request", Mutating: true,
228 Handler: s.checkOrigin(s.requireUser(s.mrReviewRequestSubmit))},
229 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/label", Mutating: true,
230 Handler: s.checkOrigin(s.requireUser(s.mrLabelSubmit))},
231 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/merge", Mutating: true,
232 Handler: s.checkOrigin(s.requireUser(s.mrMergeSubmit))},
233 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/close", Mutating: true,
234 Handler: s.checkOrigin(s.requireUser(s.mrCloseSubmit))},
235 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/draft", Mutating: true,
236 Handler: s.checkOrigin(s.requireUser(s.mrDraftSubmit))},
237 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/retarget", Mutating: true,
238 Handler: s.checkOrigin(s.requireUser(s.mrRetargetSubmit))},
239 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/thread", Mutating: true,
240 Handler: s.checkOrigin(s.requireUser(s.mrThreadSubmit))},
241 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/diff-comment", Mutating: true,
242 Handler: s.checkOrigin(s.requireUser(s.mrDiffCommentSubmit))},
243 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/suggestion", Mutating: true,
244 Handler: s.checkOrigin(s.requireUser(s.mrSuggestionSubmit))},
245 Route{Method: "GET", Pattern: "/{owner}/{repo}/edit/{ref}/{path...}",
246 Handler: s.requireUser(s.editForm)},
247 Route{Method: "POST", Pattern: "/{owner}/{repo}/edit/{ref}/{path...}", Mutating: true,
248 Handler: s.checkOrigin(s.requireUser(s.editSubmit))},
249 )
250 }
251 return routes
252}
253
254func (s *Server) Handler() http.Handler {
255 mux := http.NewServeMux()
256 for _, r := range s.Routes() {
257 mux.HandleFunc(r.Method+" "+r.Pattern, r.Handler)
258 }
259 // A path no pattern matches gets the 404 page, not net/http's
260 // plain-text body (#232), unless dropping a trailing slash makes it
261 // match (#233).
262 mux.HandleFunc("/", s.unmatched(mux))
263 var h http.Handler = mux
264 if len(s.cfg.GoImport) > 0 {
265 h = s.goImportHandler(mux)
266 }
267 // Always wrapped: custom pages domains work with or without the
268 // built-in [pages] domain.
269 return compressed(s.pagesRouter(s.securityHeaders(h)))
270}
271
272// unmatched answers a path no pattern matched. A GET whose path ends in
273// a slash and resolves without it redirects there, so /cmc/ reaches /cmc
274// and /cmc/-/snippets/ reaches /cmc/-/snippets (#233). Everything else is
275// the 404 page. Patterns ending in a {path...} wildcard already accept
276// the slash and never arrive here.
277func (s *Server) unmatched(mux *http.ServeMux) http.HandlerFunc {
278 return func(w http.ResponseWriter, r *http.Request) {
279 p := r.URL.Path
280 if len(p) > 1 && strings.HasSuffix(p, "/") && (r.Method == "GET" || r.Method == "HEAD") {
281 trimmed := r.Clone(r.Context())
282 u := *r.URL
283 u.Path = strings.TrimRight(p, "/")
284 trimmed.URL = &u
285 // The fallback itself is registered at "/", so a miss
286 // reports that pattern; a real route reports its own.
287 if _, pattern := mux.Handler(trimmed); pattern != "" && pattern != "/" {
288 // net/http fills Scheme and Host from an
289 // absolute-form request line, which RFC 7230
290 // requires a server to accept; carrying them
291 // into Location sends the reader off-site.
292 u.Scheme, u.Host, u.User = "", "", nil
293 http.Redirect(w, r, u.String(), http.StatusMovedPermanently)
294 return
295 }
296 }
297 s.notFound(w, r)
298 }
299}
300
301// securityHeaders sets defensive response headers on every reply. The CSP
302// is strict where it can be: no scripts at all (the UI needs none), no
303// plugins, no embedding. Inline styles are allowed because label chips
304// carry their color inline (chroma is class-based so the syntax palette
305// can follow the color scheme). Images may load from anywhere so external README images
306// still render; they are the one thing a reader-facing forge can't police
307// without a proxy.
308func (s *Server) securityHeaders(next http.Handler) http.Handler {
309 const csp = "default-src 'self'; script-src 'none'; style-src 'self' 'unsafe-inline'; " +
310 "img-src * data:; object-src 'none'; base-uri 'none'; form-action 'self'; frame-ancestors 'none'"
311 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
312 hd := w.Header()
313 hd.Set("Content-Security-Policy", csp)
314 hd.Set("X-Frame-Options", "DENY")
315 hd.Set("X-Content-Type-Options", "nosniff")
316 hd.Set("Referrer-Policy", "no-referrer")
317 hd.Set("Cross-Origin-Opener-Policy", "same-origin")
318 if s.cfg.HTTP.TLS != "off" {
319 hd.Set("Strict-Transport-Security", "max-age=31536000; includeSubDomains")
320 }
321 next.ServeHTTP(w, r)
322 })
323}
324
325func (s *Server) goImportHandler(mux http.Handler) http.Handler {
326 // Vanity Go modules: ?go-get=1 requests under a configured module
327 // path answer with the go-import meta tag before normal routing.
328 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
329 if r.URL.Query().Get("go-get") == "1" {
330 host := r.Host
331 if h, _, err := net.SplitHostPort(host); err == nil {
332 host = h
333 }
334 requested := host + strings.TrimSuffix(r.URL.Path, "/")
335 for module, repo := range s.cfg.GoImport {
336 if requested == module || strings.HasPrefix(requested, module+"/") {
337 w.Header().Set("Content-Type", "text/html; charset=utf-8")
338 fmt.Fprintf(w, `<!DOCTYPE html><html><head><meta name="go-import" content="%s git %s/%s.git"></head><body>%s</body></html>`,
339 module, s.cfg.Server.SiteURL, repo, module)
340 return
341 }
342 }
343 }
344 mux.ServeHTTP(w, r)
345 })
346}