forked from open-horizon/edge-sync-service
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiServer.go
3989 lines (3734 loc) · 121 KB
/
apiServer.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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package base
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
"strconv"
"strings"
"time"
"github.com/open-horizon/edge-sync-service/core/security"
"github.com/open-horizon/edge-sync-service/common"
"github.com/open-horizon/edge-sync-service/core/communications"
"github.com/open-horizon/edge-utilities/logger"
"github.com/open-horizon/edge-utilities/logger/log"
"github.com/open-horizon/edge-utilities/logger/trace"
)
const destinationsURL = "/api/v1/destinations"
const objectsURL = "/api/v1/objects/"
const organizationURL = "/api/v1/organizations/"
const getOrganizationsURL = "/api/v1/organizations"
const resendURL = "/api/v1/resend"
const securityURL = "/api/v1/security/"
const shutdownURL = "/api/v1/shutdown"
const healthURL = "/api/v1/health"
const (
contentType = "Content-Type"
applicationJSON = "application/json"
)
var unauthorizedBytes = []byte("Unauthorized")
// objectUpdate includes the object's metadata and data
// A sync service object includes metadata and optionally binary data.
// When an object is created the metadata must be provided. The metadata and the data can then be updated together or one at a time.
// swagger:model
type objectUpdate struct {
// Meta is the object's metadata
Meta common.MetaData `json:"meta"`
// Data is a the object's binary data
Data []byte `json:"data"`
}
// webhookUpdate includes the webhook's action and URL
// A webhook can be used to allow the sync service to invoke actions when new information becomes available.
// An application can choose between using a webhook and periodically polling the sync service for updates.
// swagger:model
type webhookUpdate struct {
// Action is an action can be either register (create/update a webhook) or delete (delete the webhook)
Action string `json:"action"`
// URL is the URL to invoke when new information for the object is available
URL string `json:"url"`
}
// organization includes the organization's id and broker address
// swagger:model
type organization struct {
// Organization ID
OrgID string `json:"org-id"`
// Broker address
Address string `json:"address"`
}
// bulkACLUpdate is the payload used when performing a bulk update on an ACL (either adding uses to an
// ACL or removing users from an ACL.
// swagger:model
type bulkACLUpdate struct {
// Action is an action, which can be either add (to add users) or remove (to remove users)
Action string `json:"action"`
// aclUsers is an array of ACL entries to be added or removed from the ACL as appropriate. Don's specify ACLRole if action is "remove"
Users []common.ACLentry `json:"users"`
}
func setupAPIServer() {
if common.Configuration.NodeType == common.CSS {
http.Handle(destinationsURL+"/", http.StripPrefix(destinationsURL+"/", http.HandlerFunc(handleDestinations)))
http.Handle(securityURL, http.StripPrefix(securityURL, http.HandlerFunc(handleSecurity)))
} else {
http.HandleFunc(destinationsURL, handleDestinations)
}
http.Handle(objectsURL, http.StripPrefix(objectsURL, http.HandlerFunc(handleObjects)))
http.HandleFunc(shutdownURL, handleShutdown)
http.HandleFunc(resendURL, handleResend)
http.Handle(getOrganizationsURL, http.StripPrefix(getOrganizationsURL, http.HandlerFunc(handleGetOrganizations)))
http.Handle(organizationURL, http.StripPrefix(organizationURL, http.HandlerFunc(handleOrganizations)))
http.HandleFunc(healthURL, handleHealth)
}
func handleDestinations(writer http.ResponseWriter, request *http.Request) {
setResponseHeaders(writer)
if !common.Running {
writer.WriteHeader(http.StatusServiceUnavailable)
return
}
code, userOrg, _ := security.Authenticate(request)
if code == security.AuthFailed || code == security.AuthEdgeNode {
writer.WriteHeader(http.StatusForbidden)
writer.Write(unauthorizedBytes)
return
}
if request.Method != http.MethodGet {
writer.WriteHeader(http.StatusMethodNotAllowed)
return
}
var orgID string
var parts []string
if len(request.URL.Path) != 0 {
parts = strings.Split(request.URL.Path, "/")
if common.Configuration.NodeType == common.CSS {
if len(parts) == 0 {
writer.WriteHeader(http.StatusBadRequest)
return
}
orgID = parts[0]
parts = parts[1:]
} else {
orgID = common.Configuration.OrgID
}
} else {
if common.Configuration.NodeType == common.CSS {
writer.WriteHeader(http.StatusBadRequest)
return
}
orgID = common.Configuration.OrgID
}
if pathParamValid := validatePathParam(writer, orgID, "", "", "", ""); !pathParamValid {
// header and message are set in function validatePathParam
return
}
if userOrg != orgID && code != security.AuthSyncAdmin {
writer.WriteHeader(http.StatusForbidden)
writer.Write(unauthorizedBytes)
return
}
if len(parts) == 0 || (len(parts) == 1 && len(parts[0]) == 0) {
// swagger:operation GET /api/v1/destinations/{orgID} handleDestinations
//
// List all known destinations.
//
// Provides a list of destinations for an organization, i.e., ESS nodes (belonging to orgID) that have registered with the CSS.
// This is a CSS only API.
//
// ---
//
// tags:
// - CSS
//
// produces:
// - application/json
// - text/plain
//
// parameters:
// - name: orgID
// in: path
// description: The orgID of the destinations to return.
// required: true
// type: string
//
// responses:
// '200':
// description: Destinations response
// schema:
// type: array
// items:
// "$ref": "#/definitions/Destination"
// '404':
// description: No destinations found
// schema:
// type: string
// '500':
// description: Failed to retrieve the destinations
// schema:
// type: string
if dests, err := ListDestinations(orgID); err != nil {
communications.SendErrorResponse(writer, err, "Failed to fetch the list of destinations. Error: ", 0)
} else {
if len(dests) == 0 {
writer.WriteHeader(http.StatusNotFound)
} else {
if data, err := json.MarshalIndent(dests, "", " "); err != nil {
communications.SendErrorResponse(writer, err, "Failed to marshal the list of destinations. Error: ", 0)
} else {
writer.Header().Add(contentType, applicationJSON)
writer.WriteHeader(http.StatusOK)
if _, err := writer.Write(data); err != nil && log.IsLogging(logger.ERROR) {
log.Error("Failed to write response body, error: " + err.Error())
}
}
}
}
} else if len(parts) == 3 || (len(parts) == 4 && len(parts[3]) == 0) && parts[2] == "objects" {
// swagger:operation GET /api/v1/destinations/{orgID}/{destType}/{destID}/objects handleDestinationObjects
//
// List all objects that are in use by the destination.
//
// Provides a list of objects that are in use by the destination ESS node.
// This is a CSS only API.
//
// ---
//
// tags:
// - CSS
//
// produces:
// - application/json
// - text/plain
//
// parameters:
// - name: orgID
// in: path
// description: The orgID of the destination to retrieve objects for.
// required: true
// type: string
// - name: destType
// in: path
// description: The destType of the destination to retrieve objects for.
// required: true
// type: string
// - name: destID
// in: path
// description: The destID of the destination to retrieve objects for.
// required: true
// type: string
//
// responses:
// '200':
// description: Objects response
// schema:
// type: array
// items:
// "$ref": "#/definitions/ObjectStatus"
// '404':
// description: No objects found
// schema:
// type: string
// '500':
// description: Failed to retrieve the objects
// schema:
// type: string
if pathParamValid := validatePathParam(writer, orgID, "", "", parts[0], parts[1]); !pathParamValid {
// header and message are set in function validatePathParam
return
}
if objects, err := GetObjectsForDestination(orgID, parts[0], parts[1]); err != nil {
communications.SendErrorResponse(writer, err, "Failed to fetch the objects. Error: ", 0)
} else {
if len(objects) == 0 {
writer.WriteHeader(http.StatusNotFound)
} else {
if data, err := json.MarshalIndent(objects, "", " "); err != nil {
communications.SendErrorResponse(writer, err, "Failed to marshal the list of objects. Error: ", 0)
} else {
writer.Header().Add(contentType, applicationJSON)
writer.WriteHeader(http.StatusOK)
if _, err := writer.Write(data); err != nil && log.IsLogging(logger.ERROR) {
log.Error("Failed to write response body, error: " + err.Error())
}
}
}
}
} else {
writer.WriteHeader(http.StatusBadRequest)
}
}
// swagger:operation POST /api/v1/resend handleResend
//
// Request to resend objects.
//
// Used by an ESS to ask the CSS to resend it all the objects (supported only for ESS to CSS requests).
// An application only needs to use this API in case the data it previously obtained from the ESS was lost.
//
// ---
//
// tags:
// - ESS
//
// produces:
// - text/plain
//
// responses:
// '204':
// description: The request will be sent
// schema:
// type: string
// '400':
// description: The request is not allowed on Cloud Sync-Service
// schema:
// type: string
func handleResend(writer http.ResponseWriter, request *http.Request) {
setResponseHeaders(writer)
if !common.Running {
writer.WriteHeader(http.StatusServiceUnavailable)
return
}
code, _, _ := security.Authenticate(request)
if code != security.AuthAdmin && code != security.AuthUser && code != security.AuthSyncAdmin {
writer.WriteHeader(http.StatusForbidden)
writer.Write(unauthorizedBytes)
return
}
if request.Method == http.MethodPost {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In handleResend\n")
}
if err := ResendObjects(); err != nil {
communications.SendErrorResponse(writer, err, "Failed to send resend objects request. Error: ", 0)
} else {
writer.WriteHeader(http.StatusNoContent)
}
} else {
writer.WriteHeader(http.StatusMethodNotAllowed)
}
}
// POST /api/v1/shutdown?essunregister=true
func handleShutdown(writer http.ResponseWriter, request *http.Request) {
setResponseHeaders(writer)
code, _, _ := security.Authenticate(request)
if code != security.AuthSyncAdmin {
writer.WriteHeader(http.StatusForbidden)
writer.Write(unauthorizedBytes)
return
}
if request.Method == http.MethodPost {
writer.WriteHeader(http.StatusNoContent)
restart := strings.ToLower(request.URL.Query().Get("restart"))
quiesceString := request.URL.Query().Get("quiesce")
essUnregister := false
if common.Configuration.NodeType == common.ESS {
unregisterString := request.URL.Query().Get("essunregister")
var err error
if unregisterString != "" {
essUnregister, err = strconv.ParseBool(unregisterString)
if err != nil {
writer.WriteHeader(http.StatusBadRequest)
return
}
}
}
go func() {
timer := time.NewTimer(time.Duration(1) * time.Second)
<-timer.C
quieceTime := 3
if len(quiesceString) != 0 {
var quieceTemp int
_, err := fmt.Sscanf(quiesceString, "%d", &quieceTemp)
if err == nil {
quieceTime = quieceTemp
}
}
if restart == "true" || restart == "yes" {
// If BlockUntilShutdown was called, don't let Stop() unblock
blocking := waitingOnBlockChannel
waitingOnBlockChannel = false
Stop(quieceTime, essUnregister)
if log.IsLogging(logger.INFO) {
log.Info("Restarting the Sync Service")
}
Start("", false)
waitingOnBlockChannel = blocking
} else {
Stop(quieceTime, essUnregister)
}
}()
} else {
writer.WriteHeader(http.StatusMethodNotAllowed)
}
}
func handleObjects(writer http.ResponseWriter, request *http.Request) {
setResponseHeaders(writer)
if !common.Running {
writer.WriteHeader(http.StatusServiceUnavailable)
return
}
if len(request.URL.Path) != 0 {
parts := strings.Split(request.URL.Path, "/")
var orgID string
if common.Configuration.NodeType == common.CSS {
orgID = parts[0]
parts = parts[1:]
} else {
orgID = common.Configuration.OrgID
}
if len(parts) == 0 {
// GET /api/v1/objects/orgID?destination_policy=true
// GET /api/v1/objects/orgID?filters=true
if request.Method != http.MethodGet {
writer.WriteHeader(http.StatusMethodNotAllowed)
return
}
// GET /api/v1/objects/orgID?destination_policy=true, return []common.ObjectDestinationPolicy
destPolicyString := request.URL.Query().Get("destination_policy")
destPolicy := false
objectFilterString := request.URL.Query().Get("filters")
objectFilter := false
var err error
if destPolicyString != "" {
destPolicy, err = strconv.ParseBool(destPolicyString)
if err == nil && destPolicy {
handleListObjectsWithDestinationPolicy(orgID, writer, request)
return
}
} else if objectFilterString != "" {
// GET /api/v1/objects/orgID?filters=true¶m1=value1¶m2=value2.....
// this API is to filter objects which have destination policy, and return []common.Metatdata
objectFilter, err = strconv.ParseBool(objectFilterString)
if err == nil && objectFilter {
handleListObjectsWithFilters(orgID, writer, request)
return
}
}
writer.WriteHeader(http.StatusBadRequest)
return
} else if len(parts) == 1 || (len(parts) == 2 && len(parts[1]) == 0) {
// /api/v1/objects/orgID/type
// GET - get updated objects
// PUT - register/delete a webhook
switch request.Method {
case http.MethodGet:
allObjectsString := request.URL.Query().Get("all_objects")
allObjects := false
if allObjectsString != "" {
var err error
allObjects, err = strconv.ParseBool(allObjectsString)
if err != nil {
writer.WriteHeader(http.StatusBadRequest)
return
}
}
if allObjects {
handleListAllObjects(orgID, parts[0], writer, request)
} else {
receivedString := request.URL.Query().Get("received")
received := false
if receivedString != "" {
var err error
received, err = strconv.ParseBool(receivedString)
if err != nil {
writer.WriteHeader(http.StatusBadRequest)
return
}
}
handleListUpdatedObjects(orgID, parts[0], received, writer, request)
}
case http.MethodPut:
handleWebhook(orgID, parts[0], writer, request)
default:
writer.WriteHeader(http.StatusMethodNotAllowed)
}
} else if len(parts) == 2 || (len(parts) == 3 && len(parts[2]) == 0) {
// GET/DELETE/PUT /api/v1/objects/orgID/type/id
handleObjectRequest(orgID, parts[0], parts[1], writer, request)
} else if len(parts) == 3 || (len(parts) == 4 && len(parts[3]) == 0) {
// PUT /api/v1/objects/orgID/type/id/consumed
// PUT /api/v1/objects/orgID/type/id/deleted
// PUT /api/v1/objects/orgID/type/id/received
// PUT /api/v1/objects/orgID/type/id/activate
// GET /api/v1/objects/orgID/type/id/status
// GET/PUT /api/v1/objects/orgID/type/id/data
// GET/PUT /api/v1/objects/orgID/type/id/destinations
operation := strings.ToLower(parts[2])
handleObjectOperation(operation, orgID, parts[0], parts[1], writer, request)
} else {
writer.WriteHeader(http.StatusBadRequest)
}
} else {
writer.WriteHeader(http.StatusBadRequest)
}
}
func handleObjectRequest(orgID string, objectType string, objectID string, writer http.ResponseWriter, request *http.Request) {
// We need to check XSS for orgID before sending the value to security component
if pathParamValid := validatePathParam(writer, orgID, objectType, objectID, "", ""); !pathParamValid {
// header and message are set in function validatePathParam
return
}
setResponseHeaders(writer)
switch request.Method {
// swagger:operation GET /api/v1/objects/{orgID}/{objectType}/{objectID} handleGetObject
//
// Get an object.
//
// Get the metadata of an object of the specified object type and object ID.
// The metadata indicates if the objects includes data which can then be obtained using the appropriate API.
//
// ---
//
// tags:
// - CSS
//
// produces:
// - application/json
// - text/plain
//
// parameters:
// - name: orgID
// in: path
// description: The orgID of the object to return.
// required: true
// type: string
// - name: objectType
// in: path
// description: The object type of the object to return
// required: true
// type: string
// - name: objectID
// in: path
// description: The object ID of the object to return
// required: true
// type: string
//
// responses:
// '200':
// description: Object response
// schema:
// "$ref": "#/definitions/MetaData"
// '404':
// description: Object not found
// schema:
// type: string
// '500':
// description: Failed to retrieve the object
// schema:
// type: string
// ======================================================================================
// swagger:operation GET /api/v1/objects/{objectType}/{objectID} handleGetObject
//
// Get an object.
//
// Get the metadata of an object of the specified object type and object ID.
// The metadata indicates if the objects includes data which can then be obtained using the appropriate API.
//
// ---
//
// tags:
// - ESS
//
// produces:
// - application/json
// - text/plain
//
// parameters:
// - name: objectType
// in: path
// description: The object type of the object to return
// required: true
// type: string
// - name: objectID
// in: path
// description: The object ID of the object to return
// required: true
// type: string
//
// responses:
// '200':
// description: Object response
// schema:
// "$ref": "#/definitions/MetaData"
// '404':
// description: Object not found
// schema:
// type: string
// '500':
// description: Failed to retrieve the object
// schema:
// type: string
case http.MethodGet:
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In handleObjects. Get %s %s\n", objectType, objectID)
}
canAccessAllObjects, code, userID := canUserAccessObject(request, orgID, objectType, objectID, false)
if code == security.AuthFailed {
writer.WriteHeader(http.StatusForbidden)
writer.Write(unauthorizedBytes)
return
}
if metaData, err := GetObject(orgID, objectType, objectID); err != nil {
communications.SendErrorResponse(writer, err, "", 0)
} else {
if metaData == nil {
if canAccessAllObjects {
writer.WriteHeader(http.StatusNotFound)
} else {
writer.WriteHeader(http.StatusForbidden)
writer.Write(unauthorizedBytes)
}
} else {
if metaData.Public || canAccessAllObjects {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In handleObjects. Object is public %t, given user can access all object for object type(%s) %t\n", metaData.Public, objectType, canAccessAllObjects)
}
if data, err := json.MarshalIndent(metaData, "", " "); err != nil {
communications.SendErrorResponse(writer, err, "Failed to marshal metadata. Error: ", 0)
} else {
writer.Header().Add(contentType, applicationJSON)
writer.WriteHeader(http.StatusOK)
if _, err := writer.Write(data); err != nil && log.IsLogging(logger.ERROR) {
log.Error("Failed to write response body, error: " + err.Error())
}
}
} else {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In handleObjects. Given user %s doesn't have access to object %s %s in org %s\n", userID, objectType, objectID, orgID)
}
writer.WriteHeader(http.StatusForbidden)
writer.Write(unauthorizedBytes)
}
}
}
// swagger:operation DELETE /api/v1/objects/{orgID}/{objectType}/{objectID} handleDeleteObject
//
// Delete an object.
//
// Delete the object of the specified object type and object ID.
// Destinations of the object will be notified that the object has been deleted.
//
// ---
//
// tags:
// - CSS
//
// produces:
// - text/plain
//
// parameters:
// - name: orgID
// in: path
// description: The orgID of the object to delete.
// required: true
// type: string
// - name: objectType
// in: path
// description: The object type of the object to delete
// required: true
// type: string
// - name: objectID
// in: path
// description: The object ID of the object to delete
// required: true
// type: string
//
// responses:
// '204':
// description: Object deleted
// schema:
// type: string
// '500':
// description: Failed to delete the object
// schema:
// type: string
// ======================================================================================
// swagger:operation DELETE /api/v1/objects/{objectType}/{objectID} handleDeleteObject
//
// Delete an object.
//
// Delete the object of the specified object type and object ID.
// Destinations of the object will be notified that the object has been deleted.
//
// ---
//
// tags:
// - ESS
//
// produces:
// - text/plain
//
// parameters:
// - name: objectType
// in: path
// description: The object type of the object to delete
// required: true
// type: string
// - name: objectID
// in: path
// description: The object ID of the object to delete
// required: true
// type: string
//
// responses:
// '204':
// description: Object deleted
// schema:
// type: string
// '500':
// description: Failed to delete the object
// schema:
// type: string
case http.MethodDelete:
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In handleObjects. Delete %s %s\n", objectType, objectID)
}
if _, code, _ := canUserAccessObject(request, orgID, objectType, objectID, false); code == security.AuthFailed {
writer.WriteHeader(http.StatusForbidden)
writer.Write(unauthorizedBytes)
return
} else if (code == security.AuthUser || code == security.AuthNodeUser) && common.Configuration.NodeType == common.CSS {
// Retrieve metadata, check object type and destination types againest acls
if metaData, err := GetObject(orgID, objectType, objectID); err != nil {
communications.SendErrorResponse(writer, err, "", 0)
return
} else {
if metaData == nil {
writer.WriteHeader(http.StatusNotFound)
return
}
validateUser, userOrgID, userID := security.CanUserCreateObject(request, orgID, metaData)
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In handleObjects. Delete %s %s. ValidateUser %t %s %s\n", objectType, objectID, validateUser, userOrgID, userID)
}
if !validateUser {
writer.WriteHeader(http.StatusForbidden)
writer.Write(unauthorizedBytes)
return
}
}
}
if err := DeleteObject(orgID, objectType, objectID); err != nil {
communications.SendErrorResponse(writer, err, "Failed to delete the object. Error: ", 0)
} else {
writer.WriteHeader(http.StatusNoContent)
}
case http.MethodPut:
handleUpdateObject(orgID, objectType, objectID, writer, request)
default:
writer.WriteHeader(http.StatusMethodNotAllowed)
}
}
// swagger:operation GET /api/v1/objects/{orgID}?filters=true handleListObjectsWithFilters
//
// Get objects satisfy the given filters
//
// Get the list of objects that satisfy the given filters
// This is a CSS only API.
//
// ---
//
// tags:
// - CSS
//
// produces:
// - application/json
// - text/plain
//
// parameters:
// - name: orgID
// in: path
// description: The orgID of the updated objects to return. Present only when working with a CSS, removed from the path when working with an ESS
// required: true
// type: string
// - name: filters
// in: query
// description: Must be true to indicate that objects with filters are to be retrieved
// required: true
// type: boolean
// - name: destinationPolicy
// in: query
// description: Must be true to indicate that objects with destinationPolicy are to be retrieved
// required: false
// type: boolean
// - name: dpService
// in: query
// description: The ID of the service (orgID/serviceName) to which objects have affinity,
// whose Destination Policy should be fetched.
// required: false
// type: string
// - name: dpPropertyName
// in: query
// description: The property name defined inside destination policy to which objects have affinity,
// whose Destination Policy should be fetched.
// required: false
// type: string
// - name: since
// in: query
// description: Objects that have a Destination Policy which was updated since the specified timestamp in RFC3339 should be fetched.
// required: false
// type: string
// - name: objectType
// in: query
// description: Fetch the objects with given object type
// required: false
// type: string
// - name: objectID
// in: query
// description: Fetch the objects with given object id
// required: false
// type: string
// - name: destinationType
// in: query
// description: Fetch the objects with given destination type
// required: false
// type: string
// - name: destinationID
// in: query
// description: Fetch the objects with given destination id
// required: false
// type: string
// - name: noData
// in: query
// description: Fetch the objects with noData marked to true
// required: false
// type: boolean
// - name: expirationTimeBefore
// in: query
// description: Fetch the objects with expiration time before specified timestamp in RFC3339 format
// required: false
// type: string
//
// responses:
// '200':
// description: Objects response
// schema:
// type: array
// items:
// "$ref": "#/definitions/MetaData"
// '404':
// description: No objects found
// schema:
// type: string
// '500':
// description: Failed to retrieve the objects
// schema:
// type: string
func handleListObjectsWithFilters(orgID string, writer http.ResponseWriter, request *http.Request) {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In handleListObjectsWithFilters")
}
// We need to check XSS for orgID before sending the value to security component
if pathParamValid := validatePathParam(writer, orgID, "", "", "", ""); !pathParamValid {
// header and message are set in function validatePathParam
return
}
// only allow AuthSyncAdmin, AuthAdmin, AuthUser and AuthNodeUser to access, it is okay if orgID != userOrgID to display "public" object
code, userOrgID, userID := security.Authenticate(request)
if code == security.AuthFailed || (code != security.AuthSyncAdmin && code != security.AuthAdmin && code != security.AuthUser && code != security.AuthNodeUser) {
writer.WriteHeader(http.StatusForbidden)
writer.Write(unauthorizedBytes)
return
}
destinationPolicyString := request.URL.Query().Get("destinationPolicy")
var destinationPolicy *bool
if destinationPolicyString != "" {
var err error
destinationPolicyValue, err := strconv.ParseBool(destinationPolicyString)
destinationPolicy = &destinationPolicyValue
if err != nil {
writer.WriteHeader(http.StatusBadRequest)
return
}
}
dpServiceOrgID := ""
dpServiceName := ""
dpPropertyName := ""
since := int64(0)
if destinationPolicy != nil && *destinationPolicy == true {
dpServiceID := request.URL.Query().Get("dpService")
if dpServiceID != "" {
parts := strings.SplitN(dpServiceID, "/", 2)
if len(parts) < 2 || len(parts[0]) == 0 || len(parts[1]) == 0 {
writer.WriteHeader(http.StatusBadRequest)
return
}
dpServiceOrgID = parts[0]
dpServiceName = parts[1]
}
dpPropertyName = request.URL.Query().Get("dpPropertyName")
if pathParamValid := validatePathParamForService(writer, dpServiceOrgID, dpServiceName, dpPropertyName); !pathParamValid {
// header and message are set in function validatePathParam
return
}
sinceString := request.URL.Query().Get("since")
if sinceString != "" {
var err error
sinceTime, err := time.Parse(time.RFC3339, sinceString)
if err != nil {
writer.WriteHeader(http.StatusBadRequest)
return
}
since = sinceTime.UTC().UnixNano()
if since < 1 {
writer.WriteHeader(http.StatusBadRequest)
return
}
}
}
objectType := request.URL.Query().Get("objectType")
objectID := ""
if objectType != "" {
objectID = request.URL.Query().Get("objectID")
}
destinationType := request.URL.Query().Get("destinationType")
destinationID := ""
if destinationType != "" {
destinationID = request.URL.Query().Get("destinationID")
}
if pathParamValid := validatePathParam(writer, orgID, objectType, objectID, destinationType, destinationID); !pathParamValid {
// header and message are set in function validatePathParam
return
}
var noData *bool
noDataString := request.URL.Query().Get("noData")
if noDataString != "" {
var err error
noDataVelue, err := strconv.ParseBool(noDataString)
noData = &noDataVelue
if err != nil {
writer.WriteHeader(http.StatusBadRequest)
return
}
}
expirationTimeBeforeString := request.URL.Query().Get("expirationTimeBefore")
if expirationTimeBeforeString != "" {
_, err := time.Parse(time.RFC3339, expirationTimeBeforeString)
if err != nil {
writer.WriteHeader(http.StatusBadRequest)
return
}
}
var objects []common.MetaData
var err error
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In handleListObjectsWithFilters, get objects with %s %s %s %s %s %d %s %s %s %s %s %s\n", orgID, destinationPolicyString, dpServiceOrgID, dpServiceName, dpPropertyName, since, objectType, objectID, destinationType, destinationID, noDataString, expirationTimeBeforeString)
}
if objects, err = ListObjectsWithFilters(orgID, destinationPolicy, dpServiceOrgID, dpServiceName, dpPropertyName, since, objectType, objectID, destinationType, destinationID, noData, expirationTimeBeforeString); err != nil {
communications.SendErrorResponse(writer, err, "Failed to fetch the list of objects with given conditions. Error: ", 0)
} else {
if len(objects) == 0 {
writer.WriteHeader(http.StatusNotFound)
} else {
if accessibleObjects, err := GetAccessibleObjects(code, orgID, userOrgID, userID, objects); err != nil {