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