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