-
Notifications
You must be signed in to change notification settings - Fork 726
/
router.go
404 lines (349 loc) · 15.5 KB
/
router.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
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
package router
import (
"context"
"crypto/tls"
"encoding/json"
"fmt"
"net/http"
"os"
"strings"
"time"
analyticsBuild "github.com/prebid/prebid-server/v2/analytics/build"
"github.com/prebid/prebid-server/v2/config"
"github.com/prebid/prebid-server/v2/currency"
"github.com/prebid/prebid-server/v2/endpoints"
"github.com/prebid/prebid-server/v2/endpoints/events"
infoEndpoints "github.com/prebid/prebid-server/v2/endpoints/info"
"github.com/prebid/prebid-server/v2/endpoints/openrtb2"
"github.com/prebid/prebid-server/v2/errortypes"
"github.com/prebid/prebid-server/v2/exchange"
"github.com/prebid/prebid-server/v2/experiment/adscert"
"github.com/prebid/prebid-server/v2/floors"
"github.com/prebid/prebid-server/v2/gdpr"
"github.com/prebid/prebid-server/v2/hooks"
"github.com/prebid/prebid-server/v2/macros"
"github.com/prebid/prebid-server/v2/metrics"
metricsConf "github.com/prebid/prebid-server/v2/metrics/config"
"github.com/prebid/prebid-server/v2/modules"
"github.com/prebid/prebid-server/v2/modules/moduledeps"
"github.com/prebid/prebid-server/v2/openrtb_ext"
"github.com/prebid/prebid-server/v2/pbs"
pbc "github.com/prebid/prebid-server/v2/prebid_cache_client"
"github.com/prebid/prebid-server/v2/router/aspects"
"github.com/prebid/prebid-server/v2/server/ssl"
storedRequestsConf "github.com/prebid/prebid-server/v2/stored_requests/config"
"github.com/prebid/prebid-server/v2/usersync"
"github.com/prebid/prebid-server/v2/util/jsonutil"
"github.com/prebid/prebid-server/v2/util/uuidutil"
"github.com/prebid/prebid-server/v2/version"
_ "github.com/go-sql-driver/mysql"
"github.com/golang/glog"
"github.com/julienschmidt/httprouter"
_ "github.com/lib/pq"
"github.com/rs/cors"
)
// NewJsonDirectoryServer is used to serve .json files from a directory as a single blob. For example,
// given a directory containing the files "a.json" and "b.json", this returns a Handle which serves JSON like:
//
// {
// "a": { ... content from the file a.json ... },
// "b": { ... content from the file b.json ... }
// }
//
// This function stores the file contents in memory, and should not be used on large directories.
// If the root directory, or any of the files in it, cannot be read, then the program will exit.
func NewJsonDirectoryServer(schemaDirectory string, validator openrtb_ext.BidderParamValidator, aliases map[string]string) httprouter.Handle {
return newJsonDirectoryServer(schemaDirectory, validator, aliases, openrtb_ext.GetAliasBidderToParent())
}
func newJsonDirectoryServer(schemaDirectory string, validator openrtb_ext.BidderParamValidator, aliases map[string]string, yamlAliases map[openrtb_ext.BidderName]openrtb_ext.BidderName) httprouter.Handle {
// Slurp the files into memory first, since they're small and it minimizes request latency.
files, err := os.ReadDir(schemaDirectory)
if err != nil {
glog.Fatalf("Failed to read directory %s: %v", schemaDirectory, err)
}
bidderMap := openrtb_ext.BuildBidderMap()
data := make(map[string]json.RawMessage, len(files))
for _, file := range files {
bidder := strings.TrimSuffix(file.Name(), ".json")
bidderName, isValid := bidderMap[bidder]
if !isValid {
glog.Fatalf("Schema exists for an unknown bidder: %s", bidder)
}
data[bidder] = json.RawMessage(validator.Schema(bidderName))
}
// Add in any aliases
for aliasName, parentBidder := range yamlAliases {
data[string(aliasName)] = json.RawMessage(validator.Schema(parentBidder))
}
// Add in any default aliases
for aliasName, bidderName := range aliases {
bidderData, ok := data[bidderName]
if !ok {
glog.Fatalf("Default alias (%s) exists referencing unknown bidder: %s", aliasName, bidderName)
}
data[aliasName] = bidderData
}
response, err := json.Marshal(data)
if err != nil {
glog.Fatalf("Failed to marshal bidder param JSON-schema: %v", err)
}
return func(w http.ResponseWriter, _ *http.Request, _ httprouter.Params) {
w.Header().Add("Content-Type", "application/json")
w.Write(response)
}
}
func serveIndex(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {
http.ServeFile(w, r, "static/index.html")
}
type NoCache struct {
Handler http.Handler
}
func (m NoCache) ServeHTTP(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Cache-Control", "no-cache, no-store, must-revalidate")
w.Header().Add("Pragma", "no-cache")
w.Header().Add("Expires", "0")
m.Handler.ServeHTTP(w, r)
}
type Router struct {
*httprouter.Router
MetricsEngine *metricsConf.DetailedMetricsEngine
ParamsValidator openrtb_ext.BidderParamValidator
Shutdown func()
}
func New(cfg *config.Configuration, rateConvertor *currency.RateConverter) (r *Router, err error) {
const schemaDirectory = "./static/bidder-params"
r = &Router{
Router: httprouter.New(),
}
// For bid processing, we need both the hardcoded certificates and the certificates found in container's
// local file system
certPool := ssl.GetRootCAPool()
var readCertErr error
certPool, readCertErr = ssl.AppendPEMFileToRootCAPool(certPool, cfg.PemCertsFile)
if readCertErr != nil {
glog.Infof("Could not read certificates file: %s \n", readCertErr.Error())
}
generalHttpClient := &http.Client{
Transport: &http.Transport{
Proxy: http.ProxyFromEnvironment,
MaxConnsPerHost: cfg.Client.MaxConnsPerHost,
MaxIdleConns: cfg.Client.MaxIdleConns,
MaxIdleConnsPerHost: cfg.Client.MaxIdleConnsPerHost,
IdleConnTimeout: time.Duration(cfg.Client.IdleConnTimeout) * time.Second,
TLSClientConfig: &tls.Config{RootCAs: certPool},
},
}
cacheHttpClient := &http.Client{
Transport: &http.Transport{
Proxy: http.ProxyFromEnvironment,
MaxConnsPerHost: cfg.CacheClient.MaxConnsPerHost,
MaxIdleConns: cfg.CacheClient.MaxIdleConns,
MaxIdleConnsPerHost: cfg.CacheClient.MaxIdleConnsPerHost,
IdleConnTimeout: time.Duration(cfg.CacheClient.IdleConnTimeout) * time.Second,
},
}
floorFechterHttpClient := &http.Client{
Transport: &http.Transport{
Proxy: http.ProxyFromEnvironment,
MaxConnsPerHost: cfg.PriceFloors.Fetcher.HttpClient.MaxConnsPerHost,
MaxIdleConns: cfg.PriceFloors.Fetcher.HttpClient.MaxIdleConns,
MaxIdleConnsPerHost: cfg.PriceFloors.Fetcher.HttpClient.MaxIdleConnsPerHost,
IdleConnTimeout: time.Duration(cfg.PriceFloors.Fetcher.HttpClient.IdleConnTimeout) * time.Second,
},
}
if err := checkSupportedUserSyncEndpoints(cfg.BidderInfos); err != nil {
return nil, err
}
syncersByBidder, errs := usersync.BuildSyncers(cfg, cfg.BidderInfos)
if len(errs) > 0 {
return nil, errortypes.NewAggregateError("user sync", errs)
}
syncerKeys := make([]string, 0, len(syncersByBidder))
syncerKeysHashSet := map[string]struct{}{}
for _, syncer := range syncersByBidder {
syncerKeysHashSet[syncer.Key()] = struct{}{}
}
for k := range syncerKeysHashSet {
syncerKeys = append(syncerKeys, k)
}
moduleDeps := moduledeps.ModuleDeps{HTTPClient: generalHttpClient, RateConvertor: rateConvertor}
repo, moduleStageNames, err := modules.NewBuilder().Build(cfg.Hooks.Modules, moduleDeps)
if err != nil {
glog.Fatalf("Failed to init hook modules: %v", err)
}
// Metrics engine
r.MetricsEngine = metricsConf.NewMetricsEngine(cfg, openrtb_ext.CoreBidderNames(), syncerKeys, moduleStageNames)
shutdown, fetcher, ampFetcher, accounts, categoriesFetcher, videoFetcher, storedRespFetcher := storedRequestsConf.NewStoredRequests(cfg, r.MetricsEngine, generalHttpClient, r.Router)
// todo(zachbadgett): better shutdown
r.Shutdown = shutdown
analyticsRunner := analyticsBuild.New(&cfg.Analytics)
paramsValidator, err := openrtb_ext.NewBidderParamsValidator(schemaDirectory)
if err != nil {
glog.Fatalf("Failed to create the bidder params validator. %v", err)
}
activeBidders := exchange.GetActiveBidders(cfg.BidderInfos)
disabledBidders := exchange.GetDisabledBidderWarningMessages(cfg.BidderInfos)
defaultAliases, defReqJSON := readDefaultRequest(cfg.DefReqConfig)
if err := validateDefaultAliases(defaultAliases); err != nil {
return nil, err
}
gvlVendorIDs := cfg.BidderInfos.ToGVLVendorIDMap()
vendorListFetcher := gdpr.NewVendorListFetcher(context.Background(), cfg.GDPR, generalHttpClient, gdpr.VendorListURLMaker)
gdprPermsBuilder := gdpr.NewPermissionsBuilder(cfg.GDPR, gvlVendorIDs, vendorListFetcher)
tcf2CfgBuilder := gdpr.NewTCF2Config
cacheClient := pbc.NewClient(cacheHttpClient, &cfg.CacheURL, &cfg.ExtCacheURL, r.MetricsEngine)
adapters, adaptersErrs := exchange.BuildAdapters(generalHttpClient, cfg, cfg.BidderInfos, r.MetricsEngine)
if len(adaptersErrs) > 0 {
errs := errortypes.NewAggregateError("Failed to initialize adapters", adaptersErrs)
return nil, errs
}
adsCertSigner, err := adscert.NewAdCertsSigner(cfg.Experiment.AdCerts)
if err != nil {
glog.Fatalf("Failed to create ads cert signer: %v", err)
}
priceFloorFetcher := floors.NewPriceFloorFetcher(cfg.PriceFloors, floorFechterHttpClient, r.MetricsEngine)
tmaxAdjustments := exchange.ProcessTMaxAdjustments(cfg.TmaxAdjustments)
planBuilder := hooks.NewExecutionPlanBuilder(cfg.Hooks, repo)
macroReplacer := macros.NewStringIndexBasedReplacer()
theExchange := exchange.NewExchange(adapters, cacheClient, cfg, syncersByBidder, r.MetricsEngine, cfg.BidderInfos, gdprPermsBuilder, rateConvertor, categoriesFetcher, adsCertSigner, macroReplacer, priceFloorFetcher)
var uuidGenerator uuidutil.UUIDRandomGenerator
openrtbEndpoint, err := openrtb2.NewEndpoint(uuidGenerator, theExchange, paramsValidator, fetcher, accounts, cfg, r.MetricsEngine, analyticsRunner, disabledBidders, defReqJSON, activeBidders, storedRespFetcher, planBuilder, tmaxAdjustments)
if err != nil {
glog.Fatalf("Failed to create the openrtb2 endpoint handler. %v", err)
}
ampEndpoint, err := openrtb2.NewAmpEndpoint(uuidGenerator, theExchange, paramsValidator, ampFetcher, accounts, cfg, r.MetricsEngine, analyticsRunner, disabledBidders, defReqJSON, activeBidders, storedRespFetcher, planBuilder, tmaxAdjustments)
if err != nil {
glog.Fatalf("Failed to create the amp endpoint handler. %v", err)
}
videoEndpoint, err := openrtb2.NewVideoEndpoint(uuidGenerator, theExchange, paramsValidator, fetcher, videoFetcher, accounts, cfg, r.MetricsEngine, analyticsRunner, disabledBidders, defReqJSON, activeBidders, cacheClient, tmaxAdjustments)
if err != nil {
glog.Fatalf("Failed to create the video endpoint handler. %v", err)
}
requestTimeoutHeaders := config.RequestTimeoutHeaders{}
if cfg.RequestTimeoutHeaders != requestTimeoutHeaders {
videoEndpoint = aspects.QueuedRequestTimeout(videoEndpoint, cfg.RequestTimeoutHeaders, r.MetricsEngine, metrics.ReqTypeVideo)
}
r.POST("/openrtb2/auction", openrtbEndpoint)
r.POST("/openrtb2/video", videoEndpoint)
r.GET("/openrtb2/amp", ampEndpoint)
r.GET("/info/bidders", infoEndpoints.NewBiddersEndpoint(cfg.BidderInfos, defaultAliases))
r.GET("/info/bidders/:bidderName", infoEndpoints.NewBiddersDetailEndpoint(cfg.BidderInfos, defaultAliases))
r.GET("/bidders/params", NewJsonDirectoryServer(schemaDirectory, paramsValidator, defaultAliases))
r.POST("/cookie_sync", endpoints.NewCookieSyncEndpoint(syncersByBidder, cfg, gdprPermsBuilder, tcf2CfgBuilder, r.MetricsEngine, analyticsRunner, accounts, activeBidders).Handle)
r.GET("/status", endpoints.NewStatusEndpoint(cfg.StatusResponse))
r.GET("/", serveIndex)
r.Handler("GET", "/version", endpoints.NewVersionEndpoint(version.Ver, version.Rev))
r.ServeFiles("/static/*filepath", http.Dir("static"))
// vtrack endpoint
if cfg.VTrack.Enabled {
vtrackEndpoint := events.NewVTrackEndpoint(cfg, accounts, cacheClient, cfg.BidderInfos, r.MetricsEngine)
r.POST("/vtrack", vtrackEndpoint)
}
// event endpoint
eventEndpoint := events.NewEventEndpoint(cfg, accounts, analyticsRunner, r.MetricsEngine)
r.GET("/event", eventEndpoint)
userSyncDeps := &pbs.UserSyncDeps{
HostCookieConfig: &(cfg.HostCookie),
ExternalUrl: cfg.ExternalURL,
RecaptchaSecret: cfg.RecaptchaSecret,
PriorityGroups: cfg.UserSync.PriorityGroups,
}
r.GET("/setuid", endpoints.NewSetUIDEndpoint(cfg, syncersByBidder, gdprPermsBuilder, tcf2CfgBuilder, analyticsRunner, accounts, r.MetricsEngine))
r.GET("/getuids", endpoints.NewGetUIDsEndpoint(cfg.HostCookie))
r.POST("/optout", userSyncDeps.OptOut)
r.GET("/optout", userSyncDeps.OptOut)
return r, nil
}
func checkSupportedUserSyncEndpoints(bidderInfos config.BidderInfos) error {
for name, info := range bidderInfos {
if info.Syncer == nil {
continue
}
for _, endpoint := range info.Syncer.Supports {
endpointLower := strings.ToLower(endpoint)
switch endpointLower {
case "iframe":
if info.Syncer.IFrame == nil {
glog.Warningf("bidder %s supports iframe user sync, but doesn't have a default and must be configured by the host", name)
}
case "redirect":
if info.Syncer.Redirect == nil {
glog.Warningf("bidder %s supports redirect user sync, but doesn't have a default and must be configured by the host", name)
}
default:
return fmt.Errorf("failed to load bidder info for %s, user sync supported endpoint '%s' is unrecognized", name, endpoint)
}
}
}
return nil
}
// Fixes #648
//
// These CORS options pose a security risk... but it's a calculated one.
// People _must_ call us with "withCredentials" set to "true" because that's how we use the cookie sync info.
// We also must allow all origins because every site on the internet _could_ call us.
//
// This is an inherent security risk. However, PBS doesn't use cookies for authorization--just identification.
// We only store the User's ID for each Bidder, and each Bidder has already exposed a public cookie sync endpoint
// which returns that data anyway.
//
// For more info, see:
//
// - https://github.com/rs/cors/issues/55
// - https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors/CORSNotSupportingCredentials
// - https://portswigger.net/blog/exploiting-cors-misconfigurations-for-bitcoins-and-bounties
func SupportCORS(handler http.Handler) http.Handler {
c := cors.New(cors.Options{
AllowCredentials: true,
AllowOriginFunc: func(string) bool {
return true
},
AllowedHeaders: []string{"Origin", "X-Requested-With", "Content-Type", "Accept"}})
return c.Handler(handler)
}
type defReq struct {
Ext defExt `json:"ext"`
}
type defExt struct {
Prebid defaultAliases `json:"prebid"`
}
type defaultAliases struct {
Aliases map[string]string `json:"aliases"`
}
func readDefaultRequest(defReqConfig config.DefReqConfig) (map[string]string, []byte) {
defReq := &defReq{}
aliases := make(map[string]string)
if defReqConfig.Type == "file" {
if len(defReqConfig.FileSystem.FileName) == 0 {
return aliases, []byte{}
}
defReqJSON, err := os.ReadFile(defReqConfig.FileSystem.FileName)
if err != nil {
glog.Fatalf("error reading aliases from file %s: %v", defReqConfig.FileSystem.FileName, err)
return aliases, []byte{}
}
if err := jsonutil.UnmarshalValid(defReqJSON, defReq); err != nil {
// we might not have aliases defined, but will atleast show that the JSON file is parsable.
glog.Fatalf("error parsing alias json in file %s: %v", defReqConfig.FileSystem.FileName, err)
return aliases, []byte{}
}
// Read in the alias map if we want to populate the info endpoints with aliases.
if defReqConfig.AliasInfo {
aliases = defReq.Ext.Prebid.Aliases
}
return aliases, defReqJSON
}
return aliases, []byte{}
}
func validateDefaultAliases(aliases map[string]string) error {
var errs []error
for alias := range aliases {
if openrtb_ext.IsBidderNameReserved(alias) {
errs = append(errs, fmt.Errorf("alias %s is a reserved bidder name and cannot be used", alias))
}
}
if len(errs) > 0 {
return errortypes.NewAggregateError("default request alias errors", errs)
}
return nil
}