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
|
// This file is safe to edit. Once it exists it will not be overwritten
// Copyright 2022 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.
//
package restapi
import (
"crypto/tls"
"net/http"
"strconv"
"strings"
"time"
"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/urfave/negroni"
pkgapi "github.com/sigstore/timestamp-authority/pkg/api"
"github.com/sigstore/timestamp-authority/pkg/generated/restapi/operations"
"github.com/sigstore/timestamp-authority/pkg/generated/restapi/operations/timestamp"
"github.com/sigstore/timestamp-authority/pkg/internal/cmdparams"
"github.com/sigstore/timestamp-authority/pkg/log"
)
//go:generate swagger generate server --target ../../generated --name TimestampServer --spec ../../../openapi.yaml --principal interface{} --exclude-main --exclude-spec
func configureFlags(_ *operations.TimestampServerAPI) {
// api.CommandLineOptionsGroups = []swag.CommandLineOptionsGroup{ ... }
}
func configureAPI(api *operations.TimestampServerAPI) 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.ApplicationPemCertificateChainProducer = runtime.TextProducer()
api.ApplicationTimestampQueryConsumer = runtime.ByteStreamConsumer()
api.ApplicationTimestampReplyProducer = runtime.ByteStreamProducer()
api.TimestampGetTimestampResponseHandler = timestamp.GetTimestampResponseHandlerFunc(pkgapi.TimestampResponseHandler)
api.TimestampGetTimestampCertChainHandler = timestamp.GetTimestampCertChainHandlerFunc(pkgapi.GetTimestampCertChainHandler)
api.PreServerShutdown = func() {}
api.ServerShutdown = func() {}
api.AddMiddlewareFor("POST", "/api/v1/timestamp", middleware.NoCache)
api.AddMiddlewareFor("GET", "/api/v1/timestamp/certchain", cacheForDay)
return setupGlobalMiddleware(api.Serve(setupMiddlewares))
}
// The TLS configuration before HTTPS server starts.
func configureTLS(_ *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) { //nolint: revive
}
// 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...)
}
const pingPath = "/ping"
// httpPingOnly custom middleware prohibits all entrypoints except
// "/ping" on the http (non-HTTPS) server.
func httpPingOnly() func(http.Handler) http.Handler {
f := func(h http.Handler) http.Handler {
fn := func(w http.ResponseWriter, r *http.Request) {
if r.URL.Scheme != "https" && !strings.EqualFold(r.URL.Path, pingPath) {
w.Header().Set("Content-Type", "text/plain")
w.WriteHeader(http.StatusNotFound)
w.Write([]byte("http server supports only the " + pingPath + " entrypoint")) //nolint:errcheck
return
}
h.ServeHTTP(w, r)
}
return http.HandlerFunc(fn)
}
return f
}
// 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(pingPath)(returnHandler)
if cmdparams.IsHTTPPingOnly {
returnHandler = httpPingOnly()(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.RequestIDLogger(r).Sync()
}()
returnHandler.ServeHTTP(w, r)
}))
}
func wrapMetrics(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
start := time.Now()
ww := middleware.NewWrapResponseWriter(w, r.ProtoMajor)
defer func() {
// This logs latency broken down by URL path and response code
pkgapi.MetricLatency.With(map[string]string{
"path": r.URL.Path,
"code": strconv.Itoa(ww.Status()),
}).Observe(float64(time.Since(start)))
pkgapi.MetricLatencySummary.With(map[string]string{
"path": r.URL.Path,
"code": strconv.Itoa(ww.Status()),
}).Observe(float64(time.Since(start)))
pkgapi.MetricRequestLatency.With(map[string]string{
"path": r.URL.Path,
"method": r.Method,
}).Observe(float64(time.Since(start)))
pkgapi.MetricRequestCount.With(map[string]string{
"path": r.URL.Path,
"method": r.Method,
"code": strconv.Itoa(ww.Status()),
}).Inc()
}()
handler.ServeHTTP(ww, r)
})
}
func cacheForDay(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", "max-age=86400, immutable")
}
})
handler.ServeHTTP(ww, r)
})
}
func logAndServeError(w http.ResponseWriter, r *http.Request, err error) {
if apiErr, ok := err.(errors.Error); ok && apiErr.Code() == http.StatusNotFound {
log.RequestIDLogger(r).Warn(err)
} else {
log.RequestIDLogger(r).Error(err)
}
requestFields := map[string]interface{}{}
if err := mapstructure.Decode(r, &requestFields); err == nil {
log.RequestIDLogger(r).Debug(requestFields)
}
errors.ServeError(w, r, err)
}
|