/
federations.go
576 lines (518 loc) · 18.9 KB
/
federations.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
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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
package federations
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
import (
"database/sql"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"net/http"
"strings"
"time"
"github.com/apache/trafficcontrol/lib/go-log"
"github.com/apache/trafficcontrol/lib/go-rfc"
"github.com/apache/trafficcontrol/lib/go-tc"
"github.com/apache/trafficcontrol/lib/go-util"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/api"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/auth"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/dbhelpers"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/tenant"
"github.com/lib/pq"
)
const insertResolverQuery = `
INSERT INTO federation_resolver (ip_address, type)
VALUES ($1, (
SELECT type.id
FROM type
WHERE type.name = $2
))
ON CONFLICT (ip_address) DO UPDATE SET ip_address = federation_resolver.ip_address
RETURNING federation_resolver.ip_address, federation_resolver.id
`
const associateFederationWithResolverQuery = `
INSERT INTO federation_federation_resolver (federation, federation_resolver)
VALUES ($1, $2)
ON CONFLICT DO NOTHING
`
const deleteCurrentUserFederationResolversQuery = `
DELETE FROM federation_resolver
WHERE federation_resolver.id IN (
SELECT federation_federation_resolver.federation_resolver
FROM federation_federation_resolver
WHERE federation_federation_resolver.federation IN (
SELECT federation_tmuser.federation
FROM federation_tmuser
WHERE federation_tmuser.tm_user = $1
)
)
RETURNING federation_resolver.ip_address
`
func Get(w http.ResponseWriter, r *http.Request) {
inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil)
if userErr != nil || sysErr != nil {
api.HandleErr(w, r, inf.Tx.Tx, errCode, userErr, sysErr)
return
}
defer inf.Close()
code := http.StatusOK
useIMS := false
config, e := api.GetConfig(r.Context())
if e == nil && config != nil {
useIMS = config.UseIMS
} else {
log.Warnf("Couldn't get config %v", e)
}
var maxTime *time.Time
var err error
var feds []FedInfo
feds, err, code, maxTime = getUserFederations(inf.Tx.Tx, inf.User.UserName, useIMS, r.Header)
if code == http.StatusNotModified {
w.WriteHeader(code)
api.WriteResp(w, r, []tc.IAllFederation{})
return
}
if err != nil {
api.HandleErr(w, r, inf.Tx.Tx, http.StatusInternalServerError, nil, errors.New("federations.Get getting federations: "+err.Error()))
return
}
fedsResolvers, err := getFederationResolvers(inf.Tx.Tx, fedInfoIDs(feds))
if err != nil {
api.HandleErr(w, r, inf.Tx.Tx, http.StatusInternalServerError, nil, errors.New("federations.Get getting federations resolvers: "+err.Error()))
return
}
allFederations := addResolvers([]tc.IAllFederation{}, feds, fedsResolvers)
if maxTime != nil && api.SetLastModifiedHeader(r, useIMS) {
api.AddLastModifiedHdr(w, *maxTime)
}
api.WriteResp(w, r, allFederations)
}
func addResolvers(allFederations []tc.IAllFederation, feds []FedInfo, fedsResolvers map[int][]FedResolverInfo) []tc.IAllFederation {
dsFeds := map[tc.DeliveryServiceName][]tc.FederationResolverMapping{}
for _, fed := range feds {
mapping := tc.FederationResolverMapping{}
mapping.TTL = util.IntPtr(fed.TTL)
mapping.CName = util.StrPtr(fed.CName)
for _, resolver := range fedsResolvers[fed.ID] {
switch resolver.Type {
case tc.FederationResolverType4:
mapping.Resolve4 = append(mapping.Resolve4, resolver.IP)
case tc.FederationResolverType6:
mapping.Resolve6 = append(mapping.Resolve6, resolver.IP)
default:
log.Warnf("federations addResolvers got invalid resolver type for federation '%v', skipping\n", fed.ID)
}
}
dsFeds[fed.DS] = append(dsFeds[fed.DS], mapping)
}
for ds, mappings := range dsFeds {
allFederations = append(allFederations, tc.AllDeliveryServiceFederationsMapping{DeliveryService: ds, Mappings: mappings})
}
return allFederations
}
func fedInfoIDs(feds []FedInfo) []int {
ids := []int{}
for _, fed := range feds {
ids = append(ids, fed.ID)
}
return ids
}
type FedInfo struct {
ID int
TTL int
CName string
DS tc.DeliveryServiceName
}
type FedResolverInfo struct {
Type tc.FederationResolverType
IP string
}
// getFederationResolvers takes a slice of federation IDs, and returns a map[federationID]info.
func getFederationResolvers(tx *sql.Tx, fedIDs []int) (map[int][]FedResolverInfo, error) {
feds := map[int][]FedResolverInfo{}
qry := `
SELECT
ffr.federation,
frt.name as resolver_type,
fr.ip_address
FROM
federation_federation_resolver ffr
JOIN federation_resolver fr ON ffr.federation_resolver = fr.id
JOIN type frt on fr.type = frt.id
WHERE
ffr.federation = ANY($1)
`
rows, err := tx.Query(qry, pq.Array(fedIDs))
if err != nil {
return nil, errors.New("all federations resolvers querying: " + err.Error())
}
defer rows.Close()
for rows.Next() {
fedID := 0
f := FedResolverInfo{}
fType := ""
if err := rows.Scan(&fedID, &fType, &f.IP); err != nil {
return nil, errors.New("all federations resolvers scanning: " + err.Error())
}
f.Type = tc.FederationResolverTypeFromString(fType)
feds[fedID] = append(feds[fedID], f)
}
return feds, nil
}
func tryIfModifiedSinceQueryFederations(header http.Header, tx *sql.Tx, fedID interface{}, query string) (bool, time.Time) {
var max time.Time
var imsDate time.Time
var ok bool
imsDateHeader := []string{}
runSecond := true
dontRunSecond := false
if header == nil {
return runSecond, max
}
imsDateHeader = header[rfc.IfModifiedSince]
if len(imsDateHeader) == 0 {
return runSecond, max
}
if imsDate, ok = rfc.ParseHTTPDate(imsDateHeader[0]); !ok {
log.Warnf("IMS request header date '%s' not parsable", imsDateHeader[0])
return runSecond, max
}
rows, err := tx.Query(query, fedID)
if err != nil {
log.Warnf("Couldn't get the max last updated time: %v", err)
return runSecond, max
}
if err == sql.ErrNoRows {
return dontRunSecond, max
}
defer rows.Close()
// This should only ever contain one row
if rows.Next() {
v := tc.TimeNoMod{}
if err = rows.Scan(&v); err != nil {
log.Warnf("Failed to parse the max time stamp into a struct %v", err)
return runSecond, max
}
max = v.Time
// The request IMS time is later than the max of (lastUpdated, deleted_time)
if imsDate.After(v.Time) {
return dontRunSecond, max
}
}
return runSecond, max
}
func getUserFederations(tx *sql.Tx, userName string, useIMS bool, header http.Header) ([]FedInfo, error, int, *time.Time) {
var runSecond bool
var maxTime time.Time
feds := []FedInfo{}
qry := `
SELECT
fds.federation,
fd.ttl,
fd.cname,
ds.xml_id
FROM
federation_deliveryservice fds
JOIN deliveryservice ds ON ds.id = fds.deliveryservice
JOIN federation fd ON fd.id = fds.federation
JOIN federation_tmuser fu on fu.federation = fd.id
JOIN tm_user u on u.id = fu.tm_user
WHERE
u.username = $1
ORDER BY
ds.xml_id
`
imsQuery := `SELECT Max(t)
FROM ((SELECT Greatest(fdsmax, ffrmax, fdmax) AS t
FROM (SELECT Max(fds.last_updated) AS fdsmax,
Max(ffr.last_updated) AS ffrmax,
Max(fd.last_updated) AS fdmax
FROM federation_deliveryservice fds
JOIN federation_federation_resolver ffr
ON ffr.federation = fds.federation
JOIN federation fd
ON fd.id = fds.federation
JOIN federation_tmuser fu
ON fu.federation = fd.id
JOIN tm_user u
ON u.id = fu.tm_user
WHERE u.username = $1) AS t
UNION ALL
SELECT Max(last_updated) AS t
FROM last_deleted l
WHERE l.table_name IN ( 'federation_deliveryservice', 'federation', 'federation_federation_resolver' ))) AS res;`
if useIMS {
runSecond, maxTime = tryIfModifiedSinceQuery(header, tx, userName, imsQuery)
if !runSecond {
log.Debugln("IMS HIT")
return feds, nil, http.StatusNotModified, &maxTime
}
log.Debugln("IMS MISS")
} else {
log.Debugln("Non IMS request")
}
rows, err := tx.Query(qry, userName)
if err != nil {
return nil, errors.New("user federations querying: " + err.Error()), http.StatusInternalServerError, nil
}
defer rows.Close()
for rows.Next() {
f := FedInfo{}
if err := rows.Scan(&f.ID, &f.TTL, &f.CName, &f.DS); err != nil {
return nil, errors.New("user federations scanning: " + err.Error()), http.StatusInternalServerError, nil
}
feds = append(feds, f)
}
return feds, nil, http.StatusOK, &maxTime
}
// AddFederationResolverMappingsForCurrentUser is the handler for a POST request to /federations.
// Confusingly, it does not create a federation, but is instead used to manipulate the resolvers
// used by one or more particular Delivery Services for one or more particular Federations.
func AddFederationResolverMappingsForCurrentUser(w http.ResponseWriter, r *http.Request) {
inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil)
tx := inf.Tx.Tx
if userErr != nil || sysErr != nil {
api.HandleErr(w, r, tx, errCode, userErr, sysErr)
return
}
defer inf.Close()
mappings, userErr, sysErr := getMappingsFromRequestBody(r.Body)
if userErr != nil || sysErr != nil {
api.HandleErr(w, r, tx, http.StatusBadRequest, userErr, sysErr)
return
}
if err := mappings.Validate(tx); err != nil {
errCode = http.StatusBadRequest
userErr = fmt.Errorf("validating request: %v", err)
api.HandleErr(w, r, tx, errCode, userErr, nil)
return
}
userErr, sysErr, errCode = addFederationResolverMappingsForCurrentUser(inf.User, tx, mappings)
if userErr != nil || sysErr != nil {
api.HandleErr(w, r, tx, errCode, userErr, sysErr)
return
}
msg := fmt.Sprintf("%s successfully created federation resolvers.", inf.User.UserName)
api.WriteRespAlertObj(w, r, tc.SuccessLevel, msg, msg)
}
// handles the main logic of the POST handler, separated out for convenience
func addFederationResolverMappingsForCurrentUser(u *auth.CurrentUser, tx *sql.Tx, mappings []tc.DeliveryServiceFederationResolverMapping) (error, error, int) {
for _, fed := range mappings {
dsTenant, ok, err := dbhelpers.GetDSTenantIDFromXMLID(tx, fed.DeliveryService)
if err != nil {
return nil, err, http.StatusInternalServerError
} else if !ok {
return fmt.Errorf("'%s' - no such Delivery Service", fed.DeliveryService), nil, http.StatusConflict
}
if ok, err = tenant.IsResourceAuthorizedToUserTx(dsTenant, u, tx); err != nil {
err = fmt.Errorf("Checking user #%d tenancy permissions on DS '%s' (tenant #%d)", u.ID, fed.DeliveryService, dsTenant)
return nil, err, http.StatusInternalServerError
} else if !ok {
userErr := fmt.Errorf("'%s' - no such Delivery Service", fed.DeliveryService)
sysErr := fmt.Errorf("User '%s' requested unauthorized federation resolver mapping modification on the '%s' Delivery Service", u.UserName, fed.DeliveryService)
return userErr, sysErr, http.StatusConflict
}
fedID, ok, err := dbhelpers.GetFederationIDForUserIDByXMLID(tx, u.ID, fed.DeliveryService)
if err != nil {
return nil, fmt.Errorf("Getting Federation ID: %v", err), http.StatusInternalServerError
} else if !ok {
err = fmt.Errorf("No federation(s) found for user %s on delivery service '%s'.", u.UserName, fed.DeliveryService)
return err, nil, http.StatusConflict
}
inserted, err := addFederationResolverMappingsToFederation(fed.Mappings, fed.DeliveryService, fedID, tx)
if err != nil {
err = fmt.Errorf("Adding federation resolver mapping(s) to federation: %v", err)
return nil, err, http.StatusInternalServerError
}
changelogMsg := "FEDERATION DELIVERY SERVICE: %s, ID: %d, ACTION: User %s successfully added federation resolvers [ %s ]"
changelogMsg = fmt.Sprintf(changelogMsg, fed.DeliveryService, fedID, u.UserName, inserted)
api.CreateChangeLogRawTx(api.ApiChange, changelogMsg, u, tx)
}
return nil, nil, http.StatusOK
}
// adds federation resolver mappings for a particular delivery service to a given federation, creating said resolvers if
// they don't already exist.
func addFederationResolverMappingsToFederation(res tc.ResolverMapping, xmlid string, fed uint, tx *sql.Tx) (string, error) {
var resp string
if len(res.Resolve4) > 0 {
inserted, err := addFederationResolver(res.Resolve4, tc.FederationResolverType4, fed, tx)
if err != nil {
return "", err
}
resp = strings.Join(inserted, ", ")
}
if len(res.Resolve6) > 0 {
inserted, err := addFederationResolver(res.Resolve6, tc.FederationResolverType6, fed, tx)
if err != nil {
return "", err
}
resp += strings.Join(inserted, ", ")
}
return resp, nil
}
// adds federation resolvers of a specific type to the given federation
func addFederationResolver(res []string, t tc.FederationResolverType, fedID uint, tx *sql.Tx) ([]string, error) {
inserted := []string{}
for _, r := range res {
var ip string
var id uint
if err := tx.QueryRow(insertResolverQuery, r, t).Scan(&ip, &id); err != nil {
return nil, err
}
inserted = append(inserted, ip)
if _, err := tx.Exec(associateFederationWithResolverQuery, fedID, id); err != nil {
return nil, err
}
}
return inserted, nil
}
// RemoveFederationResolverMappingsForCurrentUser is the handler for a DELETE request to /federations
// Confusingly, it does not delete a federation, but is instead used to remove an association
// between all federation resolvers and all federations assigned to the authenticated user.
func RemoveFederationResolverMappingsForCurrentUser(w http.ResponseWriter, r *http.Request) {
inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil)
tx := inf.Tx.Tx
if userErr != nil || sysErr != nil {
api.HandleErr(w, r, tx, errCode, userErr, sysErr)
return
}
defer inf.Close()
ips, userErr, sysErr, errCode := removeFederationResolverMappingsForCurrentUser(tx, inf.User)
if userErr != nil || sysErr != nil {
api.HandleErr(w, r, tx, errCode, userErr, sysErr)
return
}
// I'm not sure if I necessarily agree with treating this as a client error, but it's what Perl did.
if len(ips) < 1 {
errCode = http.StatusConflict
userErr = fmt.Errorf("No federation resolvers to delete for user %s", inf.User.UserName)
api.HandleErr(w, r, tx, errCode, userErr, nil)
return
}
ipList := fmt.Sprintf("[ %s ]", strings.Join(ips, ", "))
msg := fmt.Sprintf("%s successfully deleted all federation resolvers: %s", inf.User.UserName, ipList)
changelogMsg := fmt.Sprintf("USER: %s, ID: %d, ACTION: %s", inf.User.UserName, inf.User.ID, msg)
api.CreateChangeLogRawTx(api.ApiChange, changelogMsg, inf.User, tx)
api.WriteRespAlertObj(w, r, tc.SuccessLevel, msg, msg)
}
// handles the main logic of the DELETE handler, separated out for convenience
func removeFederationResolverMappingsForCurrentUser(tx *sql.Tx, u *auth.CurrentUser) ([]string, error, error, int) {
rows, err := tx.Query(deleteCurrentUserFederationResolversQuery, u.ID)
if err != nil {
if err == sql.ErrNoRows {
return nil, fmt.Errorf("No federation resolvers to delete for user %s", u.UserName), nil, http.StatusConflict
} else {
return nil, nil, fmt.Errorf("Deleting federation resolvers for user %s: %v", u.UserName, err), http.StatusInternalServerError
}
}
defer rows.Close()
ips := []string{}
for rows.Next() {
var ip string
if err := rows.Scan(&ip); err != nil {
return nil, nil, fmt.Errorf("Error scanning deleted resolver IP: %v", err), http.StatusInternalServerError
}
ips = append(ips, ip)
}
return ips, nil, nil, http.StatusOK
}
func ReplaceFederationResolverMappingsForCurrentUser(w http.ResponseWriter, r *http.Request) {
inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil)
tx := inf.Tx.Tx
if userErr != nil || sysErr != nil {
api.HandleErr(w, r, tx, errCode, userErr, sysErr)
return
}
defer inf.Close()
ips, userErr, sysErr, errCode := removeFederationResolverMappingsForCurrentUser(tx, inf.User)
if userErr != nil || sysErr != nil {
api.HandleErr(w, r, tx, errCode, userErr, sysErr)
return
}
ipList := fmt.Sprintf("[ %s ]", strings.Join(ips, ", "))
deletedMsg := fmt.Sprintf("%s successfully deleted all federation resolvers: %s", inf.User.UserName, ipList)
changelogMsg := fmt.Sprintf("USER: %s, ID: %d, ACTION: %s", inf.User.UserName, inf.User.ID, deletedMsg)
api.CreateChangeLogRawTx(api.ApiChange, changelogMsg, inf.User, tx)
mappings, userErr, sysErr := getMappingsFromRequestBody(r.Body)
if userErr != nil || sysErr != nil {
api.HandleErr(w, r, tx, http.StatusBadRequest, userErr, sysErr)
return
}
if err := mappings.Validate(tx); err != nil {
errCode = http.StatusBadRequest
userErr = fmt.Errorf("validating request: %v", err)
api.HandleErr(w, r, tx, errCode, userErr, nil)
return
}
userErr, sysErr, errCode = addFederationResolverMappingsForCurrentUser(inf.User, tx, mappings)
if userErr != nil || sysErr != nil {
api.HandleErr(w, r, tx, errCode, userErr, sysErr)
return
}
createdMsg := fmt.Sprintf("%s successfully created federation resolvers.", inf.User.UserName)
alerts := tc.Alerts{
Alerts: []tc.Alert{
tc.Alert{
Level: tc.SuccessLevel.String(),
Text: deletedMsg,
},
tc.Alert{
Level: tc.SuccessLevel.String(),
Text: createdMsg,
},
},
}
resp := struct {
tc.Alerts
Response string `json:"response"`
}{
alerts,
createdMsg,
}
respBts, err := json.Marshal(resp)
if err != nil {
sysErr = fmt.Errorf("Marshalling response: %v", err)
errCode = http.StatusInternalServerError
api.HandleErr(w, r, tx, errCode, nil, sysErr)
return
}
w.Header().Set(rfc.ContentType, rfc.ApplicationJSON)
api.WriteAndLogErr(w, r, append(respBts, '\n'))
}
// retrieves mappings from the given request body using the rules of the given api Version
func getMappingsFromRequestBody(body io.ReadCloser) (tc.DeliveryServiceFederationResolverMappingRequest, error, error) {
defer body.Close()
var mappings tc.DeliveryServiceFederationResolverMappingRequest
b, err := ioutil.ReadAll(body)
if err != nil {
return mappings, errors.New("Couldn't read request"), fmt.Errorf("Reading request body: %v", err)
}
var req tc.DeliveryServiceFederationResolverMappingRequest
// fall back on legacy behavior
if err := json.Unmarshal(b, &req); err != nil {
var request tc.LegacyDeliveryServiceFederationResolverMappingRequest
if err = json.Unmarshal(b, &request); err != nil {
return mappings, fmt.Errorf("parsing request: %v", err), nil
}
req = request.Federations
}
mappings = req
return mappings, nil, nil
}