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
|
package main
import (
"context"
cryptotls "crypto/tls"
"errors"
"fmt"
"net"
"net/http"
"os/signal"
"syscall"
"time"
ghandlers "github.com/gorilla/handlers"
"github.com/hashicorp/go-multierror"
"github.com/rs/cors"
"gitlab.com/gitlab-org/go-mimedb"
"gitlab.com/gitlab-org/labkit/correlation"
"gitlab.com/gitlab-org/labkit/log"
labmetrics "gitlab.com/gitlab-org/labkit/metrics"
"gitlab.com/gitlab-org/labkit/monitoring"
"golang.org/x/sync/errgroup"
"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/customheaders"
"gitlab.com/gitlab-org/gitlab-pages/internal/domain"
"gitlab.com/gitlab-org/gitlab-pages/internal/errortracking"
"gitlab.com/gitlab-org/gitlab-pages/internal/handlers"
health "gitlab.com/gitlab-org/gitlab-pages/internal/healthcheck"
"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/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/internal/tls"
"gitlab.com/gitlab-org/gitlab-pages/internal/urilimiter"
"gitlab.com/gitlab-org/gitlab-pages/metrics"
)
var (
corsHandler = cors.New(cors.Options{AllowedMethods: []string{http.MethodGet, http.MethodHead}})
)
type theApp struct {
config *cfg.Config
source source.Source
tlsConfig *cryptotls.Config
Artifact *artifact.Artifact
Auth *auth.Auth
Handlers *handlers.Handlers
CustomHeaders http.Header
}
func (a *theApp) GetCertificate(ch *cryptotls.ClientHelloInfo) (*cryptotls.Certificate, error) {
if ch.ServerName == "" {
return nil, nil
}
if domain, _ := a.domain(context.Background(), ch.ServerName); domain != nil {
certificate, _ := domain.EnsureCertificate()
return certificate, nil
}
return nil, nil
}
func (a *theApp) getTLSConfig() (*cryptotls.Config, error) {
// we call this function only when tls config is needed, and we ignore TLS related flags otherwise
// in theory you can configure both listen-https and listen-proxyv2,
// so this return is here to have a single TLS config
if a.tlsConfig != nil {
return a.tlsConfig, nil
}
var err error
a.tlsConfig, err = tls.GetTLSConfig(a.config, a.GetCertificate)
return a.tlsConfig, err
}
func (a *theApp) domain(ctx context.Context, host string) (*domain.Domain, error) {
return a.source.GetDomain(ctx, host)
}
// 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 := domain.FromRequest(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))
})
}
// 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
}
// TODO: move the pipeline configuration to internal/pipeline https://gitlab.com/gitlab-org/gitlab-pages/-/issues/670
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 = handlers.ArtifactMiddleware(handler, a.Handlers)
handler = a.Auth.AuthenticationMiddleware(handler, a.source)
handler = handlers.AcmeMiddleware(handler, a.source, a.config.GitLab.PublicServer)
handler = routing.NewMiddleware(handler, a.source)
// Add auto redirect
handler = handlers.HTTPSRedirectMiddleware(handler, a.config.General.RedirectHTTP)
handler = handlers.Ratelimiter(handler, &a.config.RateLimit)
// Health Check
handler = health.NewMiddleware(handler, a.config.General.StatusPath)
// 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 = handlePanicMiddleware(handler)
// Access logs and metrics
handler, err := logging.BasicAccessLogger(handler, a.config.Log.Format)
if err != nil {
return nil, err
}
metricsMiddleware := labmetrics.NewHandlerFactory(labmetrics.WithNamespace("gitlab_pages"))
handler = metricsMiddleware(handler)
handler = correlation.InjectCorrelationID(handler, correlationOpts...)
// These middlewares MUST be added in the end.
// Being last means they will be evaluated first
// preventing any operation on bogus requests.
handler = urilimiter.NewMiddleware(handler, a.config.General.MaxURILength)
handler = rejectmethods.NewMiddleware(handler)
return handler, nil
}
// nolint: gocyclo // ignore this
func (a *theApp) Run() error {
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 {
return fmt.Errorf("unable to configure pipeline: %w", err)
}
proxyHandler := ghandlers.ProxyHeaders(commonHandlerPipeline)
httpHandler := a.httpInitialMiddleware(commonHandlerPipeline)
ctx, stop := signal.NotifyContext(context.Background(), syscall.SIGTERM, syscall.SIGINT)
defer stop()
eg, ctx := errgroup.WithContext(ctx)
var servers []*http.Server
// Listen for HTTP
for _, addr := range a.config.ListenHTTPStrings.Split() {
s := a.listen(
eg,
addr,
httpHandler,
errortracking.WithField("listener", request.SchemeHTTP),
withLimiter(limiter),
)
servers = append(servers, s)
}
// Listen for HTTPS
for _, addr := range a.config.ListenHTTPSStrings.Split() {
tlsConfig, err := a.getTLSConfig()
if err != nil {
return fmt.Errorf("unable to retrieve tls config: %w", err)
}
s := a.listen(
eg,
addr,
httpHandler,
errortracking.WithField("listener", request.SchemeHTTPS),
withLimiter(limiter),
withTLSConfig(tlsConfig),
)
servers = append(servers, s)
}
// Listen for HTTP proxy requests
for _, addr := range a.config.ListenProxyStrings.Split() {
s := a.listen(
eg,
addr,
proxyHandler,
errortracking.WithField("listener", "http proxy"),
withLimiter(limiter),
)
servers = append(servers, s)
}
// Listen for HTTPS PROXYv2 requests
for _, addr := range a.config.ListenHTTPSProxyv2Strings.Split() {
tlsConfig, err := a.getTLSConfig()
if err != nil {
return fmt.Errorf("unable to retrieve tls config: %w", err)
}
s := a.listen(
eg,
addr,
httpHandler,
errortracking.WithField("listener", "https proxy"),
withLimiter(limiter),
withTLSConfig(tlsConfig),
withProxyV2(),
)
servers = append(servers, s)
}
// Serve metrics for Prometheus
if a.config.Metrics.Address != "" {
s := a.listenMetrics(eg, a.config.Metrics)
servers = append(servers, s)
}
<-ctx.Done()
var result *multierror.Error
for _, srv := range servers {
ctx, cancel := context.WithTimeout(context.Background(), a.config.General.ServerShutdownTimeout)
if err := srv.Shutdown(ctx); err != nil {
result = multierror.Append(result, err)
}
cancel()
}
if err := eg.Wait(); err != nil {
result = multierror.Append(result, err)
}
if result.ErrorOrNil() != nil {
errortracking.CaptureErrWithStackTrace(result.ErrorOrNil())
return result.ErrorOrNil()
}
return nil
}
func (a *theApp) listen(eg *errgroup.Group, addr string, h http.Handler, errTrackingOpt errortracking.CaptureOption, opts ...option) *http.Server {
server := &http.Server{}
eg.Go(func() error {
if err := a.listenAndServe(server, addr, h, opts...); err != nil && !errors.Is(err, http.ErrServerClosed) {
errortracking.CaptureErrWithStackTrace(err, errTrackingOpt)
return err
}
return nil
})
return server
}
func (a *theApp) listenMetrics(eg *errgroup.Group, config cfg.Metrics) *http.Server {
server := &http.Server{}
eg.Go(func() error {
l, err := net.Listen("tcp", config.Address)
if err != nil {
errortracking.CaptureErrWithStackTrace(err, errortracking.WithField("listener", "metrics"))
return fmt.Errorf("failed to listen on addr %s: %w", config.Address, err)
}
if config.TLSConfig != nil {
l = cryptotls.NewListener(l, config.TLSConfig)
}
monitoringOpts := []monitoring.Option{
monitoring.WithBuildInformation(VERSION, ""),
monitoring.WithListener(l),
monitoring.WithServer(server),
}
err = monitoring.Start(monitoringOpts...)
if err != nil && !errors.Is(err, http.ErrServerClosed) {
errortracking.CaptureErrWithStackTrace(err, errortracking.WithField("listener", "metrics"))
return err
}
return nil
})
return server
}
func runApp(config *cfg.Config) error {
source, err := gitlab.New(&config.GitLab)
if err != nil {
return fmt.Errorf("could not create domains config source: %w", err)
}
a := theApp{config: config, source: source}
err = logging.ConfigureLogging(a.config.Log.Format, a.config.Log.Verbose)
if err != nil {
return fmt.Errorf("failed to initialize logging: %w", err)
}
a.Artifact = artifact.New(config.ArtifactsServer.URL, config.ArtifactsServer.TimeoutSeconds, config.General.Domain)
if err := a.setAuth(config); err != nil {
return err
}
a.Handlers = handlers.New(a.Auth, a.Artifact)
if len(config.General.CustomHeaders) != 0 {
customHeaders, err := customheaders.ParseHeaderString(config.General.CustomHeaders)
if err != nil {
return fmt.Errorf("unable to parse header string: %w", err)
}
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 {
return fmt.Errorf("failed to reconfigure zip VFS: %w", err)
}
return a.Run()
}
func (a *theApp) setAuth(config *cfg.Config) error {
if config.Authentication.ClientID == "" {
return nil
}
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, config.Authentication.Timeout)
if err != nil {
return fmt.Errorf("could not initialize auth package: %w", err)
}
return nil
}
// handlePanicMiddleware logs and captures the recover() information from any panic
func handlePanicMiddleware(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
defer func() {
i := recover()
if i != nil {
err := fmt.Errorf("panic trace: %v", i)
metrics.PanicRecoveredCount.Inc()
logging.LogRequest(r).WithError(err).Error("recovered from panic")
errortracking.CaptureErrWithReqAndStackTrace(err, r)
httperrors.Serve500(w)
}
}()
handler.ServeHTTP(w, r)
})
}
|