forked from sigstore/rekor
/
configure_rekor_server.go
284 lines (232 loc) · 9.76 KB
/
configure_rekor_server.go
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
/*
Copyright © 2020 The Sigstore Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// This file is safe to edit. Once it exists it will not be overwritten
package restapi
import (
"context"
"crypto/tls"
"net/http"
"strconv"
"time"
// using embed to add the static html page duing build time
_ "embed"
"github.com/go-chi/chi/middleware"
"github.com/go-openapi/errors"
"github.com/go-openapi/runtime"
"github.com/mitchellh/mapstructure"
"github.com/rs/cors"
"github.com/spf13/viper"
pkgapi "github.com/sigstore/rekor/pkg/api"
"github.com/sigstore/rekor/pkg/generated/restapi/operations"
"github.com/sigstore/rekor/pkg/generated/restapi/operations/entries"
"github.com/sigstore/rekor/pkg/generated/restapi/operations/index"
"github.com/sigstore/rekor/pkg/generated/restapi/operations/pubkey"
"github.com/sigstore/rekor/pkg/generated/restapi/operations/tlog"
"github.com/sigstore/rekor/pkg/log"
"github.com/sigstore/rekor/pkg/util"
"github.com/urfave/negroni"
)
//go:generate swagger generate server --target ../../generated --name RekorServer --spec ../../../openapi.yaml --principal interface{} --exclude-main
type contextKey string
var (
ctxKeyAPIToRecord = contextKey("apiToRecord")
)
// Context payload for recording metrics.
type apiToRecord struct {
method *string // Method to record in metrics, if any.
path *string // Path to record in metrics, if any.
}
func configureFlags(api *operations.RekorServerAPI) {
// api.CommandLineOptionsGroups = []swag.CommandLineOptionsGroup{ ... }
}
func configureAPI(api *operations.RekorServerAPI) http.Handler {
// configure the api here
api.ServeError = logAndServeError
// Set your custom logger if needed. Default one is log.Printf
// Expected interface func(string, ...interface{})
//
// Example:
// api.Logger = log.Printf
api.Logger = log.Logger.Infof
// api.UseSwaggerUI()
// To continue using redoc as your UI, uncomment the following line
// api.UseRedoc()
api.JSONConsumer = runtime.JSONConsumer()
api.JSONProducer = runtime.JSONProducer()
api.ApplicationXPemFileProducer = runtime.TextProducer()
api.EntriesCreateLogEntryHandler = entries.CreateLogEntryHandlerFunc(pkgapi.CreateLogEntryHandler)
api.EntriesGetLogEntryByIndexHandler = entries.GetLogEntryByIndexHandlerFunc(pkgapi.GetLogEntryByIndexHandler)
api.EntriesGetLogEntryByUUIDHandler = entries.GetLogEntryByUUIDHandlerFunc(pkgapi.GetLogEntryByUUIDHandler)
api.EntriesSearchLogQueryHandler = entries.SearchLogQueryHandlerFunc(pkgapi.SearchLogQueryHandler)
api.PubkeyGetPublicKeyHandler = pubkey.GetPublicKeyHandlerFunc(pkgapi.GetPublicKeyHandler)
api.TlogGetLogInfoHandler = tlog.GetLogInfoHandlerFunc(pkgapi.GetLogInfoHandler)
api.TlogGetLogProofHandler = tlog.GetLogProofHandlerFunc(pkgapi.GetLogProofHandler)
if viper.GetBool("enable_retrieve_api") {
api.IndexSearchIndexHandler = index.SearchIndexHandlerFunc(pkgapi.SearchIndexHandler)
} else {
api.IndexSearchIndexHandler = index.SearchIndexHandlerFunc(pkgapi.SearchIndexNotImplementedHandler)
}
api.RegisterFormat("signedCheckpoint", &util.SignedNote{}, util.SignedCheckpointValidator)
api.PreServerShutdown = func() {}
api.ServerShutdown = func() {}
// not cacheable
api.AddMiddlewareFor("GET", "/api/v1/log", middleware.NoCache)
api.AddMiddlewareFor("GET", "/api/v1/log/proof", middleware.NoCache)
api.AddMiddlewareFor("GET", "/api/v1/log/entries", middleware.NoCache)
api.AddMiddlewareFor("GET", "/api/v1/log/entries/{entryUUID}", middleware.NoCache)
api.AddMiddlewareFor("GET", "/api/v1/timestamp", middleware.NoCache)
// cache forever
api.AddMiddlewareFor("GET", "/api/v1/log/publicKey", cacheForever)
api.AddMiddlewareFor("GET", "/api/v1/log/timestamp/certchain", cacheForever)
// add metrics for explicitly handled endpoints
recordMetricsForAPI(api, "POST", "/api/v1/index/retrieve")
recordMetricsForAPI(api, "GET", "/api/v1/log")
recordMetricsForAPI(api, "GET", "/api/v1/publicKey")
recordMetricsForAPI(api, "GET", "/api/v1/log/proof")
recordMetricsForAPI(api, "GET", "/api/v1/log/entries")
recordMetricsForAPI(api, "POST", "/api/v1/log/entries")
recordMetricsForAPI(api, "GET", "/api/v1/log/entries/{entryUUID}")
recordMetricsForAPI(api, "GET", "/api/v1/log/entries/retrieve")
return setupGlobalMiddleware(api.Serve(setupMiddlewares))
}
// The TLS configuration before HTTPS server starts.
func configureTLS(tlsConfig *tls.Config) {
// Make all necessary changes to the TLS configuration here.
}
// As soon as server is initialized but not run yet, this function will be called.
// If you need to modify a config, store server instance to stop it individually later, this is the place.
// This function can be called multiple times, depending on the number of serving schemes.
// scheme value will be set accordingly: "http", "https" or "unix"
func configureServer(s *http.Server, scheme, addr string) {
}
// The middleware configuration is for the handler executors. These do not apply to the swagger.json document.
// The middleware executes after routing but before authentication, binding and validation
func setupMiddlewares(handler http.Handler) http.Handler {
return handler
}
// We need this type to act as an adapter between zap and the middleware request logger.
type logAdapter struct {
}
func (l *logAdapter) Print(v ...interface{}) {
log.Logger.Info(v...)
}
// The middleware configuration happens before anything, this middleware also applies to serving the swagger.json document.
// So this is a good place to plug in a panic handling middleware, logging and metrics
func setupGlobalMiddleware(handler http.Handler) http.Handler {
middleware.DefaultLogger = middleware.RequestLogger(
&middleware.DefaultLogFormatter{Logger: &logAdapter{}})
returnHandler := middleware.Logger(handler)
returnHandler = middleware.Recoverer(returnHandler)
returnHandler = middleware.Heartbeat("/ping")(returnHandler)
returnHandler = serveStaticContent(returnHandler)
handleCORS := cors.Default().Handler
returnHandler = handleCORS(returnHandler)
returnHandler = wrapMetrics(returnHandler)
return middleware.RequestID(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctx := r.Context()
r = r.WithContext(log.WithRequestID(ctx, middleware.GetReqID(ctx)))
defer func() {
_ = log.ContextLogger(ctx).Sync()
}()
returnHandler.ServeHTTP(w, r)
}))
}
// Populates the the apiToRecord for this method/path so metrics are emitted.
func recordMetricsForAPI(api *operations.RekorServerAPI, method string, path string) {
metricsHandler := func(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctx := r.Context()
if apiInfo, ok := ctx.Value(ctxKeyAPIToRecord).(*apiToRecord); ok {
apiInfo.method = &method
apiInfo.path = &path
} else {
log.ContextLogger(ctx).Warn("Could not attach api info - endpoint may not be monitored.")
}
handler.ServeHTTP(w, r)
})
}
api.AddMiddlewareFor(method, path, metricsHandler)
}
func wrapMetrics(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctx := r.Context()
apiInfo := apiToRecord{}
ctx = context.WithValue(ctx, ctxKeyAPIToRecord, &apiInfo)
r = r.WithContext(ctx)
start := time.Now()
ww := middleware.NewWrapResponseWriter(w, r.ProtoMajor)
defer func() {
// Only record metrics for APIs that need instrumentation.
if apiInfo.path != nil && apiInfo.method != nil {
code := strconv.Itoa(ww.Status())
labels := map[string]string{
"path": *apiInfo.path,
"code": code,
}
// This logs latency broken down by URL path and response code
// TODO(var-sdk): delete these metrics once the new metrics are safely rolled out.
pkgapi.MetricLatency.With(labels).Observe(float64(time.Since(start)))
pkgapi.MetricLatencySummary.With(labels).Observe(float64(time.Since(start)))
pkgapi.MetricRequestLatency.With(
map[string]string{
"path": *apiInfo.path,
"method": *apiInfo.method,
}).Observe(float64(time.Since(start)))
pkgapi.MetricRequestCount.With(
map[string]string{
"path": *apiInfo.path,
"method": *apiInfo.method,
"code": code,
}).Inc()
}
}()
handler.ServeHTTP(ww, r)
})
}
func cacheForever(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ww := negroni.NewResponseWriter(w)
ww.Before(func(w negroni.ResponseWriter) {
if w.Status() >= 200 && w.Status() <= 299 {
w.Header().Set("Cache-Control", "s-maxage=31536000, max-age=31536000, immutable")
}
})
handler.ServeHTTP(ww, r)
})
}
func logAndServeError(w http.ResponseWriter, r *http.Request, err error) {
ctx := r.Context()
if apiErr, ok := err.(errors.Error); ok && apiErr.Code() == http.StatusNotFound {
log.ContextLogger(ctx).Warn(err)
} else {
log.ContextLogger(ctx).Error(err)
}
requestFields := map[string]interface{}{}
if err := mapstructure.Decode(r, &requestFields); err == nil {
log.ContextLogger(ctx).Debug(requestFields)
}
errors.ServeError(w, r, err)
}
//go:embed rekorHomePage.html
var homePageBytes []byte
func serveStaticContent(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path == "/" {
w.Header().Add("Content-Type", "text/html")
w.WriteHeader(200)
_, _ = w.Write(homePageBytes)
return
}
handler.ServeHTTP(w, r)
})
}