1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
|
package main
import (
"context"
cryptotls "crypto/tls"
"errors"
"fmt"
"net"
"net/http"
"os"
"sync"
"time"
ghandlers "github.com/gorilla/handlers"
"github.com/rs/cors"
"gitlab.com/gitlab-org/labkit/log"
"gitlab.com/gitlab-org/go-mimedb"
"gitlab.com/gitlab-org/labkit/correlation"
"gitlab.com/gitlab-org/labkit/errortracking"
labmetrics "gitlab.com/gitlab-org/labkit/metrics"
"gitlab.com/gitlab-org/labkit/monitoring"
"gitlab.com/gitlab-org/gitlab-pages/internal/acme"
"gitlab.com/gitlab-org/gitlab-pages/internal/artifact"
"gitlab.com/gitlab-org/gitlab-pages/internal/auth"
cfg "gitlab.com/gitlab-org/gitlab-pages/internal/config"
"gitlab.com/gitlab-org/gitlab-pages/internal/config/tls"
"gitlab.com/gitlab-org/gitlab-pages/internal/customheaders"
"gitlab.com/gitlab-org/gitlab-pages/internal/domain"
"gitlab.com/gitlab-org/gitlab-pages/internal/handlers"
"gitlab.com/gitlab-org/gitlab-pages/internal/httperrors"
"gitlab.com/gitlab-org/gitlab-pages/internal/logging"
"gitlab.com/gitlab-org/gitlab-pages/internal/netutil"
"gitlab.com/gitlab-org/gitlab-pages/internal/ratelimiter"
"gitlab.com/gitlab-org/gitlab-pages/internal/rejectmethods"
"gitlab.com/gitlab-org/gitlab-pages/internal/request"
"gitlab.com/gitlab-org/gitlab-pages/internal/routing"
"gitlab.com/gitlab-org/gitlab-pages/internal/serving/disk/zip"
"gitlab.com/gitlab-org/gitlab-pages/internal/source"
"gitlab.com/gitlab-org/gitlab-pages/internal/source/gitlab"
"gitlab.com/gitlab-org/gitlab-pages/metrics"
)
const (
xForwardedHost = "X-Forwarded-Host"
)
var (
corsHandler = cors.New(cors.Options{AllowedMethods: []string{http.MethodGet, http.MethodHead}})
)
type theApp struct {
config *cfg.Config
source source.Source
Artifact *artifact.Artifact
Auth *auth.Auth
Handlers *handlers.Handlers
AcmeMiddleware *acme.Middleware
CustomHeaders http.Header
}
func (a *theApp) isReady() bool {
return true
}
func (a *theApp) ServeTLS(ch *cryptotls.ClientHelloInfo) (*cryptotls.Certificate, error) {
if ch.ServerName == "" {
return nil, nil
}
if domain, _ := a.domain(context.Background(), ch.ServerName); domain != nil {
tls, _ := domain.EnsureCertificate()
return tls, nil
}
return nil, nil
}
func (a *theApp) healthCheck(w http.ResponseWriter, r *http.Request, https bool) {
if a.isReady() {
w.Write([]byte("success\n"))
} else {
http.Error(w, "not yet ready", http.StatusServiceUnavailable)
}
}
func (a *theApp) redirectToHTTPS(w http.ResponseWriter, r *http.Request, statusCode int) {
u := *r.URL
u.Scheme = request.SchemeHTTPS
u.Host = r.Host
u.User = nil
http.Redirect(w, r, u.String(), statusCode)
}
func (a *theApp) domain(ctx context.Context, host string) (*domain.Domain, error) {
return a.source.GetDomain(ctx, host)
}
// checkAuthAndServeNotFound performs the auth process if domain can't be found
// the main purpose of this process is to avoid leaking the project existence/not-existence
// by behaving the same if user has no access to the project or if project simply does not exists
func (a *theApp) checkAuthAndServeNotFound(domain *domain.Domain, w http.ResponseWriter, r *http.Request) bool {
// To avoid user knowing if pages exist, we will force user to login and authorize pages
if a.Auth.CheckAuthenticationWithoutProject(w, r, domain) {
return true
}
// auth succeeded try to serve the correct 404 page
domain.ServeNotFoundAuthFailed(w, r)
return true
}
func (a *theApp) tryAuxiliaryHandlers(w http.ResponseWriter, r *http.Request, https bool, host string, domain *domain.Domain) bool {
// Add auto redirect
if !https && a.config.General.RedirectHTTP {
a.redirectToHTTPS(w, r, http.StatusTemporaryRedirect)
return true
}
if a.Handlers.HandleArtifactRequest(host, w, r) {
return true
}
if !a.isReady() {
httperrors.Serve503(w)
return true
}
if _, err := domain.GetLookupPath(r); err != nil {
if errors.Is(err, gitlab.ErrDiskDisabled) {
errortracking.Capture(err)
httperrors.Serve500(w)
return true
}
// redirect to auth and serve not found
if a.checkAuthAndServeNotFound(domain, w, r) {
return true
}
}
if !https && domain.IsHTTPSOnly(r) {
a.redirectToHTTPS(w, r, http.StatusMovedPermanently)
return true
}
return false
}
// healthCheckMiddleware is serving the application status check
func (a *theApp) healthCheckMiddleware(handler http.Handler) (http.Handler, error) {
healthCheck := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
a.healthCheck(w, r, request.IsHTTPS(r))
})
loggedHealthCheck, err := logging.BasicAccessLogger(healthCheck, a.config.Log.Format, nil)
if err != nil {
return nil, err
}
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.RequestURI == a.config.General.StatusPath {
loggedHealthCheck.ServeHTTP(w, r)
return
}
handler.ServeHTTP(w, r)
}), nil
}
// auxiliaryMiddleware will handle status updates, not-ready requests and other
// not static-content responses
func (a *theApp) auxiliaryMiddleware(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
host := request.GetHost(r)
domain := request.GetDomain(r)
https := request.IsHTTPS(r)
if a.tryAuxiliaryHandlers(w, r, https, host, domain) {
return
}
handler.ServeHTTP(w, r)
})
}
// serveFileOrNotFoundHandler will serve static content or
// return a 404 Not Found response
func (a *theApp) serveFileOrNotFoundHandler() http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
start := time.Now()
defer metrics.ServingTime.Observe(time.Since(start).Seconds())
domain := request.GetDomain(r)
fileServed := domain.ServeFileHTTP(w, r)
if !fileServed {
// We need to trigger authentication flow here if file does not exist to prevent exposing possibly private project existence,
// because the projects override the paths of the namespace project and they might be private even though
// namespace project is public
if domain.IsNamespaceProject(r) {
if a.Auth.CheckAuthenticationWithoutProject(w, r, domain) {
return
}
}
// domain found and authentication succeeds
domain.ServeNotFoundHTTP(w, r)
}
})
}
// httpInitialMiddleware sets up HTTP requests
func (a *theApp) httpInitialMiddleware(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
handler.ServeHTTP(w, setRequestScheme(r))
})
}
// proxyInitialMiddleware sets up proxy requests
func (a *theApp) proxyInitialMiddleware(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if forwardedHost := r.Header.Get(xForwardedHost); forwardedHost != "" {
r.Host = forwardedHost
}
handler.ServeHTTP(w, r)
})
}
// setRequestScheme will update r.URL.Scheme if empty based on r.TLS
func setRequestScheme(r *http.Request) *http.Request {
if r.URL.Scheme == request.SchemeHTTPS || r.TLS != nil {
// make sure is set for non-proxy requests
r.URL.Scheme = request.SchemeHTTPS
} else {
r.URL.Scheme = request.SchemeHTTP
}
return r
}
func (a *theApp) buildHandlerPipeline() (http.Handler, error) {
// Handlers should be applied in a reverse order
handler := a.serveFileOrNotFoundHandler()
if !a.config.General.DisableCrossOriginRequests {
handler = corsHandler.Handler(handler)
}
handler = a.Auth.AuthorizationMiddleware(handler)
handler = a.auxiliaryMiddleware(handler)
handler = a.Auth.AuthenticationMiddleware(handler, a.source)
handler = a.AcmeMiddleware.AcmeMiddleware(handler)
handler, err := logging.AccessLogger(handler, a.config.Log.Format)
if err != nil {
return nil, err
}
// Metrics
metricsMiddleware := labmetrics.NewHandlerFactory(labmetrics.WithNamespace("gitlab_pages"))
handler = metricsMiddleware(handler)
handler = routing.NewMiddleware(handler, a.source)
if a.config.RateLimit.SourceIPLimitPerSecond > 0 {
rl := ratelimiter.New(
metrics.RateLimitSourceIPBlockedCount,
metrics.RateLimitSourceIPCachedEntries,
metrics.RateLimitSourceIPCacheRequests,
ratelimiter.WithSourceIPLimitPerSecond(a.config.RateLimit.SourceIPLimitPerSecond),
ratelimiter.WithSourceIPBurstSize(a.config.RateLimit.SourceIPBurst),
)
handler = rl.SourceIPLimiter(handler)
}
// Health Check
handler, err = a.healthCheckMiddleware(handler)
if err != nil {
return nil, err
}
// Custom response headers
handler = customheaders.NewMiddleware(handler, a.CustomHeaders)
// Correlation ID injection middleware
var correlationOpts []correlation.InboundHandlerOption
if a.config.General.PropagateCorrelationID {
correlationOpts = append(correlationOpts, correlation.WithPropagation())
}
handler = correlation.InjectCorrelationID(handler, correlationOpts...)
// This MUST be the last handler!
// This handler blocks unknown HTTP methods,
// being the last means it will be evaluated first
// preventing any operation on bogus requests.
handler = rejectmethods.NewMiddleware(handler)
return handler, nil
}
func (a *theApp) Run() {
var wg sync.WaitGroup
var limiter *netutil.Limiter
if a.config.General.MaxConns > 0 {
limiter = netutil.NewLimiterWithMetrics(
a.config.General.MaxConns,
metrics.LimitListenerMaxConns,
metrics.LimitListenerConcurrentConns,
metrics.LimitListenerWaitingConns,
)
}
// Use a common pipeline to use a single instance of each handler,
// instead of making two nearly identical pipelines
commonHandlerPipeline, err := a.buildHandlerPipeline()
if err != nil {
log.WithError(err).Fatal("Unable to configure pipeline")
}
proxyHandler := a.proxyInitialMiddleware(ghandlers.ProxyHeaders(commonHandlerPipeline))
httpHandler := a.httpInitialMiddleware(commonHandlerPipeline)
// Listen for HTTP
for _, fd := range a.config.Listeners.HTTP {
a.listenHTTPFD(&wg, fd, httpHandler, limiter)
}
// Listen for HTTPS
for _, fd := range a.config.Listeners.HTTPS {
a.listenHTTPSFD(&wg, fd, httpHandler, limiter)
}
// Listen for HTTP proxy requests
for _, fd := range a.config.Listeners.Proxy {
a.listenProxyFD(&wg, fd, proxyHandler, limiter)
}
// Listen for HTTPS PROXYv2 requests
for _, fd := range a.config.Listeners.HTTPSProxyv2 {
a.ListenHTTPSProxyv2FD(&wg, fd, httpHandler, limiter)
}
// Serve metrics for Prometheus
if a.config.ListenMetrics != 0 {
a.listenMetricsFD(&wg, a.config.ListenMetrics)
}
wg.Wait()
}
func (a *theApp) listenHTTPFD(wg *sync.WaitGroup, fd uintptr, httpHandler http.Handler, limiter *netutil.Limiter) {
wg.Add(1)
go func() {
defer wg.Done()
if err := a.listenAndServe(listenerConfig{fd: fd, handler: httpHandler, limiter: limiter}); err != nil {
capturingFatal(err, errortracking.WithField("listener", request.SchemeHTTP))
}
}()
}
func (a *theApp) listenHTTPSFD(wg *sync.WaitGroup, fd uintptr, httpHandler http.Handler, limiter *netutil.Limiter) {
wg.Add(1)
go func() {
defer wg.Done()
tlsConfig, err := a.TLSConfig()
if err != nil {
capturingFatal(err, errortracking.WithField("listener", request.SchemeHTTPS))
}
if err := a.listenAndServe(listenerConfig{fd: fd, handler: httpHandler, limiter: limiter, tlsConfig: tlsConfig}); err != nil {
capturingFatal(err, errortracking.WithField("listener", request.SchemeHTTPS))
}
}()
}
func (a *theApp) listenProxyFD(wg *sync.WaitGroup, fd uintptr, proxyHandler http.Handler, limiter *netutil.Limiter) {
wg.Add(1)
go func() {
wg.Add(1)
go func(fd uintptr) {
defer wg.Done()
if err := a.listenAndServe(listenerConfig{fd: fd, handler: proxyHandler, limiter: limiter}); err != nil {
capturingFatal(err, errortracking.WithField("listener", "http proxy"))
}
}(fd)
}()
}
// https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
func (a *theApp) ListenHTTPSProxyv2FD(wg *sync.WaitGroup, fd uintptr, httpHandler http.Handler, limiter *netutil.Limiter) {
wg.Add(1)
go func() {
defer wg.Done()
tlsConfig, err := a.TLSConfig()
if err != nil {
capturingFatal(err, errortracking.WithField("listener", request.SchemeHTTPS))
}
if err := a.listenAndServe(listenerConfig{fd: fd, handler: httpHandler, limiter: limiter, tlsConfig: tlsConfig, isProxyV2: true}); err != nil {
capturingFatal(err, errortracking.WithField("listener", request.SchemeHTTPS))
}
}()
}
func (a *theApp) listenMetricsFD(wg *sync.WaitGroup, fd uintptr) {
wg.Add(1)
go func() {
defer wg.Done()
l, err := net.FileListener(os.NewFile(fd, "[socket]"))
if err != nil {
capturingFatal(fmt.Errorf("failed to listen on FD %d: %v", fd, err), errortracking.WithField("listener", "metrics"))
}
monitoringOpts := []monitoring.Option{
monitoring.WithBuildInformation(VERSION, ""),
monitoring.WithListener(l),
}
err = monitoring.Start(monitoringOpts...)
if err != nil {
capturingFatal(err, errortracking.WithField("listener", "metrics"))
}
}()
}
func runApp(config *cfg.Config) {
source, err := gitlab.New(&config.GitLab)
if err != nil {
log.WithError(err).Fatal("could not create domains config source")
}
a := theApp{config: config, source: source}
err = logging.ConfigureLogging(a.config.Log.Format, a.config.Log.Verbose)
if err != nil {
log.WithError(err).Fatal("Failed to initialize logging")
}
if config.ArtifactsServer.URL != "" {
a.Artifact = artifact.New(config.ArtifactsServer.URL, config.ArtifactsServer.TimeoutSeconds, config.General.Domain)
}
a.setAuth(config)
a.Handlers = handlers.New(a.Auth, a.Artifact)
// TODO: This if was introduced when `gitlab-server` wasn't a required parameter
// once we completely remove support for legacy architecture and make it required
// we can just remove this if statement https://gitlab.com/gitlab-org/gitlab-pages/-/issues/581
if config.GitLab.PublicServer != "" {
a.AcmeMiddleware = &acme.Middleware{GitlabURL: config.GitLab.PublicServer}
}
if len(config.General.CustomHeaders) != 0 {
customHeaders, err := customheaders.ParseHeaderString(config.General.CustomHeaders)
if err != nil {
log.WithError(err).Fatal("Unable to parse header string")
}
a.CustomHeaders = customHeaders
}
if err := mimedb.LoadTypes(); err != nil {
log.WithError(err).Warn("Loading extended MIME database failed")
}
// TODO: reconfigure all VFS'
// https://gitlab.com/gitlab-org/gitlab-pages/-/issues/512
if err := zip.Instance().Reconfigure(config); err != nil {
fatal(err, "failed to reconfigure zip VFS")
}
a.Run()
}
func (a *theApp) setAuth(config *cfg.Config) {
if config.Authentication.ClientID == "" {
return
}
var err error
a.Auth, err = auth.New(config.General.Domain, config.Authentication.Secret, config.Authentication.ClientID, config.Authentication.ClientSecret,
config.Authentication.RedirectURI, config.GitLab.InternalServer, config.GitLab.PublicServer, config.Authentication.Scope)
if err != nil {
log.WithError(err).Fatal("could not initialize auth package")
}
}
// fatal will log a fatal error and exit.
func fatal(err error, message string) {
log.WithError(err).Fatal(message)
}
func (a *theApp) TLSConfig() (*cryptotls.Config, error) {
return tls.Create(a.config.General.RootCertificate, a.config.General.RootKey, a.ServeTLS,
a.config.General.InsecureCiphers, a.config.TLS.MinVersion, a.config.TLS.MaxVersion)
}
|