internal/httpd/routes.go
261 lines · 14189 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 routes = append(routes,
57 Route{Method: "GET", Pattern: "/favicon.svg", Handler: s.favicon},
58 Route{Method: "GET", Pattern: "/{owner}", Handler: s.ownerPage},
59 Route{Method: "GET", Pattern: "/{owner}/{repo}", Handler: s.repoHome},
60 Route{Method: "GET", Pattern: "/{owner}/{repo}/tree/{ref}/{path...}", Handler: s.tree},
61 Route{Method: "GET", Pattern: "/{owner}/{repo}/blob/{ref}/{path...}", Handler: s.blob},
62 Route{Method: "GET", Pattern: "/{owner}/{repo}/blame/{ref}/{path...}", Handler: s.blame},
63 Route{Method: "GET", Pattern: "/{owner}/{repo}/search", Handler: s.search},
64 Route{Method: "GET", Pattern: "/{owner}/{repo}/milestones", Handler: s.milestones},
65 Route{Method: "GET", Pattern: "/{owner}/{repo}/labels", Handler: s.labels},
66 Route{Method: "GET", Pattern: "/{owner}/{repo}/wiki", Handler: s.wiki},
67 Route{Method: "GET", Pattern: "/{owner}/{repo}/wiki/_raw/{path...}", Handler: s.wikiRaw},
68 Route{Method: "GET", Pattern: "/{owner}/{repo}/wiki/{page}", Handler: s.wiki},
69 Route{Method: "GET", Pattern: "/{owner}/{repo}/releases", Handler: s.releases},
70 Route{Method: "GET", Pattern: "/{owner}/{repo}/builds", Handler: s.builds},
71 Route{Method: "GET", Pattern: "/{owner}/{repo}/badge/build.svg", Handler: s.buildBadge},
72 Route{Method: "GET", Pattern: "/{owner}/{repo}/badge/build.png", Handler: s.buildBadgePNG},
73 Route{Method: "GET", Pattern: "/{owner}/{repo}/builds/{n}", Handler: s.build},
74 Route{Method: "GET", Pattern: "/{owner}/{repo}/releases/download/{tag}/{name}", Handler: s.releaseAsset},
75 Route{Method: "GET", Pattern: "/{owner}/{repo}/raw/{ref}/{path...}", Handler: s.raw},
76 Route{Method: "GET", Pattern: "/{owner}/{repo}/log", Handler: s.log},
77 Route{Method: "GET", Pattern: "/{owner}/{repo}/log/{ref}", Handler: s.log},
78 Route{Method: "GET", Pattern: "/{owner}/{repo}/commit/{sha}", Handler: s.commit},
79 Route{Method: "GET", Pattern: "/{owner}/{repo}/compare", Handler: s.compare},
80 Route{Method: "GET", Pattern: "/{owner}/{repo}/compare/{range}", Handler: s.compare},
81 Route{Method: "GET", Pattern: "/{owner}/{repo}/refs", Handler: s.refs},
82 Route{Method: "GET", Pattern: "/{owner}/{repo}/archive/{file}", Handler: s.archive},
83 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues", Handler: s.issues},
84 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues/{n}", Handler: s.issue},
85 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs", Handler: s.mrs},
86 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs/{n}", Handler: s.mr},
87 )
88
89 // The JSON API is its own opt-in surface, independent of web.mode.
90 if s.cfg.API.Enabled {
91 routes = append(routes,
92 Route{Method: "POST", Pattern: "/api/v1/cmd", Mutating: true, Handler: s.apiCmd},
93 Route{Method: "GET", Pattern: "/api/v1/read", Handler: s.apiRead},
94 )
95 }
96
97 // Account-mode routes exist only when web.mode = "accounts". In
98 // view_only they are never registered — the structural guarantee.
99 if s.cfg.Web.Mode == "accounts" {
100 routes = append(routes,
101 Route{Method: "GET", Pattern: "/login", Handler: s.login, Mutating: true}, // consumes a one-time token
102 Route{Method: "POST", Pattern: "/login", Mutating: true,
103 Handler: s.checkOrigin(s.loginSubmit)},
104 Route{Method: "POST", Pattern: "/logout", Mutating: true,
105 Handler: s.checkOrigin(s.logout)},
106 Route{Method: "GET", Pattern: "/new", Handler: s.requireUser(s.newRepoForm)},
107 Route{Method: "GET", Pattern: "/settings", Handler: s.requireUser(s.accountForm)},
108 Route{Method: "GET", Pattern: "/settings/export", Handler: s.requireUser(s.accountExport)},
109 Route{Method: "GET", Pattern: "/notifications", Handler: s.requireUser(s.notifications)},
110 Route{Method: "POST", Pattern: "/notifications", Mutating: true,
111 Handler: s.checkOrigin(s.requireUser(s.notificationsRead))},
112 Route{Method: "GET", Pattern: "/admin", Handler: s.requireUser(s.adminPage)},
113 Route{Method: "POST", Pattern: "/{owner}", Mutating: true,
114 Handler: s.checkOrigin(s.requireUser(s.orgSubmit))},
115 Route{Method: "POST", Pattern: "/settings", Mutating: true,
116 Handler: s.checkOrigin(s.requireUser(s.accountSubmit))},
117 )
118 // Web signup fronts the same registration path as SSH register,
119 // so it exists only when registration is open or invite.
120 if s.cfg.Registration.Mode != "closed" {
121 routes = append(routes,
122 Route{Method: "GET", Pattern: "/register", Handler: s.signupForm},
123 Route{Method: "POST", Pattern: "/register", Mutating: true,
124 Handler: s.checkOrigin(s.signupSubmit)},
125 )
126 }
127 routes = append(routes,
128 Route{Method: "POST", Pattern: "/new", Mutating: true,
129 Handler: s.checkOrigin(s.requireUser(s.newRepoSubmit))},
130 Route{Method: "POST", Pattern: "/{owner}/{repo}/pin", Mutating: true,
131 Handler: s.checkOrigin(s.requireUser(s.pinToggle))},
132 Route{Method: "POST", Pattern: "/{owner}/{repo}/watch", Mutating: true,
133 Handler: s.checkOrigin(s.requireUser(s.watchToggle))},
134 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues/new",
135 Handler: s.requireUser(s.issueCreateForm)},
136 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/new", Mutating: true,
137 Handler: s.checkOrigin(s.requireUser(s.issueCreateSubmit))},
138 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/comment", Mutating: true,
139 Handler: s.checkOrigin(s.requireUser(s.issueCommentSubmit))},
140 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/edit", Mutating: true,
141 Handler: s.checkOrigin(s.requireUser(s.issueEditSubmit))},
142 // Triage: each runs the matching issue command.
143 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/state", Mutating: true,
144 Handler: s.checkOrigin(s.requireUser(s.issueStateSubmit))},
145 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/label", Mutating: true,
146 Handler: s.checkOrigin(s.requireUser(s.issueLabelSubmit))},
147 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/assign", Mutating: true,
148 Handler: s.checkOrigin(s.requireUser(s.issueAssignSubmit))},
149 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/milestone", Mutating: true,
150 Handler: s.checkOrigin(s.requireUser(s.issueMilestoneSubmit))},
151 Route{Method: "POST", Pattern: "/{owner}/{repo}/releases", Mutating: true,
152 Handler: s.checkOrigin(s.requireUser(s.releaseSubmit))},
153 Route{Method: "POST", Pattern: "/{owner}/{repo}/labels", Mutating: true,
154 Handler: s.checkOrigin(s.requireUser(s.labelSubmit))},
155 Route{Method: "GET", Pattern: "/bookmarks", Handler: s.requireUser(s.bookmarksPage)},
156 Route{Method: "POST", Pattern: "/{owner}/{repo}/bookmark", Mutating: true,
157 Handler: s.checkOrigin(s.requireUser(s.bookmarkToggle))},
158 Route{Method: "POST", Pattern: "/{owner}/{repo}/fork", Mutating: true,
159 Handler: s.checkOrigin(s.requireUser(s.forkSubmit))},
160 Route{Method: "POST", Pattern: "/{owner}/{repo}/builds", Mutating: true,
161 Handler: s.checkOrigin(s.requireUser(s.buildTriggerSubmit))},
162 Route{Method: "POST", Pattern: "/{owner}/{repo}/builds/{n}/cancel", Mutating: true,
163 Handler: s.checkOrigin(s.requireUser(s.buildCancelSubmit))},
164 Route{Method: "GET", Pattern: "/{owner}/{repo}/settings",
165 Handler: s.requireUser(s.settingsForm)},
166 Route{Method: "POST", Pattern: "/{owner}/{repo}/settings", Mutating: true,
167 Handler: s.checkOrigin(s.requireUser(s.settingsSubmit))},
168 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs/new",
169 Handler: s.requireUser(s.mrCreateForm)},
170 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/new", Mutating: true,
171 Handler: s.checkOrigin(s.requireUser(s.mrCreateSubmit))},
172 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/edit", Mutating: true,
173 Handler: s.checkOrigin(s.requireUser(s.mrEditSubmit))},
174 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/comment", Mutating: true,
175 Handler: s.checkOrigin(s.requireUser(s.mrCommentSubmit))},
176 // Review loop: each runs the matching mr command.
177 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/review", Mutating: true,
178 Handler: s.checkOrigin(s.requireUser(s.mrReviewSubmit))},
179 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/review-request", Mutating: true,
180 Handler: s.checkOrigin(s.requireUser(s.mrReviewRequestSubmit))},
181 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/merge", Mutating: true,
182 Handler: s.checkOrigin(s.requireUser(s.mrMergeSubmit))},
183 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/close", Mutating: true,
184 Handler: s.checkOrigin(s.requireUser(s.mrCloseSubmit))},
185 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/draft", Mutating: true,
186 Handler: s.checkOrigin(s.requireUser(s.mrDraftSubmit))},
187 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/retarget", Mutating: true,
188 Handler: s.checkOrigin(s.requireUser(s.mrRetargetSubmit))},
189 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/thread", Mutating: true,
190 Handler: s.checkOrigin(s.requireUser(s.mrThreadSubmit))},
191 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/diff-comment", Mutating: true,
192 Handler: s.checkOrigin(s.requireUser(s.mrDiffCommentSubmit))},
193 Route{Method: "GET", Pattern: "/{owner}/{repo}/edit/{ref}/{path...}",
194 Handler: s.requireUser(s.editForm)},
195 Route{Method: "POST", Pattern: "/{owner}/{repo}/edit/{ref}/{path...}", Mutating: true,
196 Handler: s.checkOrigin(s.requireUser(s.editSubmit))},
197 )
198 }
199 return routes
200}
201
202func (s *Server) Handler() http.Handler {
203 mux := http.NewServeMux()
204 for _, r := range s.Routes() {
205 mux.HandleFunc(r.Method+" "+r.Pattern, r.Handler)
206 }
207 var h http.Handler = mux
208 if len(s.cfg.GoImport) > 0 {
209 h = s.goImportHandler(mux)
210 }
211 // Always wrapped: custom pages domains work with or without the
212 // built-in [pages] domain.
213 return s.pagesRouter(s.securityHeaders(h))
214}
215
216// securityHeaders sets defensive response headers on every reply. The CSP
217// is strict where it can be: no scripts at all (the UI needs none), no
218// plugins, no embedding. Inline styles are allowed because label chips
219// carry their color inline (chroma is class-based so the syntax palette
220// can follow the color scheme). Images may load from anywhere so external README images
221// still render; they are the one thing a reader-facing forge can't police
222// without a proxy.
223func (s *Server) securityHeaders(next http.Handler) http.Handler {
224 const csp = "default-src 'self'; script-src 'none'; style-src 'self' 'unsafe-inline'; " +
225 "img-src * data:; object-src 'none'; base-uri 'none'; form-action 'self'; frame-ancestors 'none'"
226 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
227 hd := w.Header()
228 hd.Set("Content-Security-Policy", csp)
229 hd.Set("X-Frame-Options", "DENY")
230 hd.Set("X-Content-Type-Options", "nosniff")
231 hd.Set("Referrer-Policy", "no-referrer")
232 hd.Set("Cross-Origin-Opener-Policy", "same-origin")
233 if s.cfg.HTTP.TLS != "off" {
234 hd.Set("Strict-Transport-Security", "max-age=31536000; includeSubDomains")
235 }
236 next.ServeHTTP(w, r)
237 })
238}
239
240func (s *Server) goImportHandler(mux http.Handler) http.Handler {
241 // Vanity Go modules: ?go-get=1 requests under a configured module
242 // path answer with the go-import meta tag before normal routing.
243 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
244 if r.URL.Query().Get("go-get") == "1" {
245 host := r.Host
246 if h, _, err := net.SplitHostPort(host); err == nil {
247 host = h
248 }
249 requested := host + strings.TrimSuffix(r.URL.Path, "/")
250 for module, repo := range s.cfg.GoImport {
251 if requested == module || strings.HasPrefix(requested, module+"/") {
252 w.Header().Set("Content-Type", "text/html; charset=utf-8")
253 fmt.Fprintf(w, `<!DOCTYPE html><html><head><meta name="go-import" content="%s git %s/%s.git"></head><body>%s</body></html>`,
254 module, s.cfg.Server.SiteURL, repo, module)
255 return
256 }
257 }
258 }
259 mux.ServeHTTP(w, r)
260 })
261}