-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yml
1549 lines (1529 loc) · 80.3 KB
/
openapi.yml
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
basePath: /kbs/v1
definitions:
AttesterType:
type: string
x-go-package: intel/kbs/v1/model
AuthTokenRequest:
properties:
password:
description: User account password for which authentication token is required
example: testPassword
type: string
x-go-name: Password
username:
description: User account username for which authentication token is required
example: testUser
type: string
x-go-name: Username
required:
- username
- password
type: object
x-go-package: intel/kbs/v1/model
KeyInfo:
properties:
algorithm:
description: Denotes the Encryption Algorithm (AES, RSA or EC) used while creating the key
example: rsa
type: string
x-go-name: Algorithm
curve_type:
description: Denotes the curve type used while creating the EC key
example: secp384r1
type: string
x-go-name: CurveType
key_data:
description: Denotes the private key(RSA/EC) or AES key in base64 string
example: YG2UtIG6OtaPjIIHQXJGxRmR0ozqiF3iQoVztc74ijo=
type: string
x-go-name: KeyData
key_length:
description: Denotes the key length in bits used while creating the key
example: 3072
format: int64
type: integer
x-go-name: KeyLength
kmip_key_id:
description: KMIP Key ID, if the key is already created in KMIP Backend
example: 7110194b-a703-4657-9d7f-3e02b62f2ed8
type: string
x-go-name: KmipKeyID
required:
- algorithm
- key_length
type: object
x-go-package: intel/kbs/v1/model
KeyRequest:
properties:
key_information:
$ref: '#/definitions/KeyInfo'
transfer_policy_id:
description: Universal Unique IDentifier of the Key Transfer Policy
example: 4110594b-a753-4457-7d7f-3e52b62f2ed8
format: uuid
type: string
x-go-name: TransferPolicyID
required:
- transfer_policy_id
type: object
x-go-package: intel/kbs/v1/model
KeyResponse:
properties:
created_at:
format: date-time
type: string
x-go-name: CreatedAt
id:
description: Universal Unique IDentifier of the Key created
example: 4110594b-a753-4457-7d7f-3e52b6252ed6
format: uuid
type: string
x-go-name: ID
key_info:
$ref: '#/definitions/KeyInfo'
transfer_link:
type: string
x-go-name: TransferLink
transfer_policy_id:
description: Universal Unique IDentifier of the Key Transfer Policy
example: 4110594b-a753-4457-7d7f-3e52b62f2ed8
format: uuid
type: string
x-go-name: TransferPolicyID
required:
- id
- transfer_policy_id
type: object
x-go-package: intel/kbs/v1/model
KeyResponses:
items:
$ref: '#/definitions/KeyResponse'
type: array
x-go-package: intel/kbs/v1/docs
KeyTransferPolicies:
items:
$ref: '#/definitions/KeyTransferPolicy'
type: array
x-go-package: intel/kbs/v1/docs
KeyTransferPolicy:
properties:
attestation_type:
$ref: '#/definitions/AttesterType'
created_at:
description: Asset creation time
example: "0001-01-01T00:00:00Z"
format: date-time
type: string
x-go-name: CreatedAt
id:
description: Universal Unique IDentifier of the Key Transfer Policy created
example: 4517534b-a758-4447-7d2f-3e5606152ed6
format: uuid
type: string
x-go-name: ID
sgx:
$ref: '#/definitions/SgxPolicy'
tdx:
$ref: '#/definitions/TdxPolicy'
required:
- id
- attestation_type
type: object
x-go-package: intel/kbs/v1/model
KeyTransferRequest:
properties:
attestation_token:
description: Describes the Signed JWT Token received from the workload
example: eyJhbGciOiJQUzM4NCIsImprdSI6Imh0dHBzOi8vd3d3LmludGVsLmNvbS9hbWJlci9jZXJ0cyIsImtpZCI6IjNjMjQxOGI1ZTY5ZTI2NDRiOTE2NzJmZjYwNTY2NjRkOTI0MjM0ZjAiLCJ0eXAiOiJKV1QifQ.eyJhbWJlcl90cnVzdF9zY29yZSI6MTAsImFtYmVyX3JlcG9ydF9kYXRhIjoiZWZmNWEyYTExNDg2N2FhOTQ0NjIwYzQ4Y2Q4NjcwNDZkYmY2ZjdmY2JmODQ5YTliNjZhNzg3MjJmNGRjZDdjOTAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAiLCJhbWJlcl90ZWVfaGVsZF9kYXRhIjoiQVFBQkFLMkxyUDhSZ1ROMW5naFJZWTBKQnZZQ1M3K2JCcVhoRjIzY2JkVFVRR3F3MEl2Wm9NYkpySUNmQXJ1MjVWWWpKbkZaS0Vvb1hRWmhPZUlBeTZNV0RpWEpmdDc0VnVUR25YZnNLUDk4bWNvZXBiQ2M4U1BJRFBsdkhTQy9QQWtlRzJUdlZ3QkhBbjcvcURVNXJwUENIS05xWDYweUd2SW95QjhrLzBJTzR5M2V0ekdvQjF5YVRPQ3Iyd1NCYmdUUkV1M3ppY3JJODFPL1RsK0FaWitVekFCdUxSUEgxdlBrelBQYVhCT21IN2Q4SnZXZ0RwSjhFenBNRitzakt4dXI1dkEraDNjamxDUG4yZjFjODhqZGIyNDgyUUJ2STZoanB4R2k0dWRUVVdJekdKdElKeElUbnNscThwTFpUekhnR3V2UEdYK2xkYWFKdUVPSGJBeFhDRW4zTnNGNHZvVjFSQ2I1OXBBMEI2NnZBd1RHZmFONE9pR205aGhiTk1NTnZNeGlhZmdGanJWWHpjc1BvUE5vN2hPd0dMcVJFdGUrMWkzZzlGNDBCK2hEZVV6elZhTU8zVkxHTUtEcDlUSDJqMytYSnRnU3p4dThOWlg1WEZVeGpSMlJINzV5d25vbnRNQStnaDZid1d1UUlWWWI2K0k3eHEzdWxOaUZldzZ4eWc9PSIsImFtYmVyX3NneF9tcmVuY2xhdmUiOiI4M2Y0ZTgxOTg2MWFkZWY2ZmZiMmE0ODY1ZWZlYTkzMzdiOTFlZDMwZmEzMzQ5MWIxN2YwZDVkOWU4MjA0NDEwIiwiYW1iZXJfc2d4X2lzX2RlYnVnZ2FibGUiOmZhbHNlLCJhbWJlcl9zZ3hfbXJzaWduZXIiOiI4M2Q3MTllNzdkZWFjYTE0NzBmNmJhZjYyYTRkNzc0MzAzYzg5OWRiNjkwMjBmOWM3MGVlMWRmYzA4YzdjZTllIiwiYW1iZXJfc2d4X2lzdnByb2RpZCI6MCwiYW1iZXJfc2d4X2lzdnN2biI6MCwiYW1iZXJfbWF0Y2hlZF9wb2xpY3lfaWRzIjpbImY0MzZjMzBhLTY0NGUtNGJiMi1iMzJjLTFmNWJmZjc3NTJmMiJdLCJhbWJlci1mYWl0aGZ1bC1zZXJ2aWNlLWlkcyI6WyI2YmFhNjMwMS0zMWVlLTQ1NmMtOWEzOC1lMjc5YWM3ZjZkNmEiLCJkZTU3NDU5ZC1mYjU2LTRhODgtYmU1ZC02ZjJhMzcwMzkzOWMiXSwiYW1iZXJfdGNiX3N0YXR1cyI6Ik9LIiwiYW1iZXJfZXZpZGVuY2VfdHlwZSI6IlNHWCIsImFtYmVyX3NpZ25lZF9ub25jZSI6dHJ1ZSwiYW1iZXJfY3VzdG9tX3BvbGljeSI6e30sInZlciI6IjEuMCIsImV4cCI6MTY2NDQ0NzA5MywianRpIjoiMzc5ZjBiMDctNTUzNy00YzdhLWFlNTAtODk2YTU1ZjIzNzY2IiwiaWF0IjoxNjY0NDQ2NzYzLCJpc3MiOiJBUyBBdHRlc3RhdGlvbiBUb2tlbiBJc3N1ZXIifQ.X2UDvraRVzAJpC1G1WAK2Qbx64d9WI5T_AKAq1lK5VAjEf409y5fZPxkBdZ-fGYt653nQ5Ah0-jkFRt0Yo7B2cxNmDWn61mMW9yYtt_55qHcbuDX5x4a-7MVawWjS1gLzY7qddmpzoIhwrx575c5JoQjG4qybDejRufUxhvu_XOOxSfhyh4JGRxBYNX19ZGeIbHtE3mfAXqg6qphZFfClIQLdlU-wGbefyN5mwpTK0T3eQ9Tlt0zZFrcv7lNIAPHHB52Ke9R7qdFEoVNNX-8YFMzk4gQyZdzYJS7Q3ElhQYXhBWnY5iwquftQztQcfydJL8o1OC-Ru0s-keF7OBaxABHcv5OhUKlVc44zaBnekP9lTzRCINYnVK67KxyAHsgXkK19UiX6v1FYxdcmdwZgNn5OkCwxiAMLgB8_CQku6q4aeyhCMo4acD1xKd6kkfgYQDxehLbGV6weT4E60omx6UFE13L9yANNNoWtzy0A4PJsiw0tbRPYYO8ehZ8Vgrb9sc00cdqG7_7ok-iivuxklaaSuzrY8VtkGw9T8g0w__fJ0X2KCMPcl3XfNidhOGxJ9402ff93X-QY3dHyaLOqmtJK0vlQ0vuoThseBSOezETalhFCuh-JUYZskokQ21fDPs2xDiytKubxqzrJVF1G1n1AVNWlIZXPXLyoXANS4s
type: string
x-go-name: AttestationToken
event_log:
description: Log of all events that get extended to RTMRs (runtime-extendable measurement registers) . RTMR event log is available through ACPI.
example: '[ { "rtmr": { "index":1....'
items:
format: uint8
type: integer
type: array
x-go-name: EventLog
nonce:
$ref: '#/definitions/VerifierNonce'
quote:
description: SGX\TDX Quote to be attested
example: AwACAAAAAAAHAAwAk5pyM/ecTKmUCg2zlX8GBxdZqc7ZHvph1dB/Gx0CGGUAAAAABQUMDP//AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABQAAAAAAAADnAAAAAAAAADi4Dt0xe3/egf97SCWPr8ncgUiYi9E4SNLWlL0C5rHTAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADUEqTwfvg4kqWRX7KrWEvjHhhuWk+Vq19pUP1OuGlNewAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACK0eSGrg5DJjzLRoYjBDpov80TukNTvbsNjnfQy6Ui/wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAxBAAAA6Yv94bEfYZ0eRjJtx6A5uPehGmdrMCDRHqKDzeKEePZbfVaLvmUS7rCn8SB5trPOA1R8df9nXk2jQ8aRQc6hnmiYobB5ujL44dQWqgg67mqFjIPmJsV0D+nlJMLGwBYnZZklCfDQ+82rFoExN3805BSWUvhkqaAChIJqkvIQfzBQUMDP//AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFQAAAAAAAADnAAAAAAAAAK4SPL+pbCaFYN/V3/5IVM5EPeTg+lHSgRhMlCjXo0D7AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACMT1d115ZQPpYTf3fGioKaAFasje1wFAsIGwlEkMV7/wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEABwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACjlJOfr4vl+VcNZYWRGfPkCTKi8Upz0gXEsoFD19ltXQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+1txjKVJ2JdwfOtnwK2QGXS/dL3xLnR0/UPemPHtPUYTxNIQi/CLW5lIANsuPt9K0gr2RsuHnO7TUUjSOVCHGiAAAAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8FAFwOAAAtLS0tLUJFR0lOIENFUlRJRklDQVRFLS0tLS0KTUlJRTh6Q0NCSm1nQXdJQkFnSVZBTGNPM1VWbHRVNnZOL1RTc2liUmcxM0U2c2NkTUFvR0NDcUdTTTQ5QkFNQ01IQXhJakFnQmdOVgpCQU1NR1VsdWRHVnNJRk5IV0NCUVEwc2dVR3hoZEdadmNtMGdRMEV4R2pBWUJnTlZCQW9NRVVsdWRHVnNJRU52Y25CdmNtRjBhVzl1Ck1SUXdFZ1lEVlFRSERBdFRZVzUwWVNCRGJHRnlZVEVMTUFrR0ExVUVDQXdDUTBFeEN6QUpCZ05WQkFZVEFsVlRNQjRYRFRJeU1ETXkKTlRFMU5UVTBObG9YRFRJNU1ETXlOVEUxTlRVME5sb3djREVpTUNBR0ExVUVBd3daU1c1MFpXd2dVMGRZSUZCRFN5QkRaWEowYVdacApZMkYwWlRFYU1CZ0dBMVVFQ2d3UlNXNTBaV3dnUTI5eWNHOXlZWFJwYjI0eEZEQVNCZ05WQkFjTUMxTmhiblJoSUVOc1lYSmhNUXN3CkNRWURWUVFJREFKRFFURUxNQWtHQTFVRUJoTUNWVk13V1RBVEJnY3Foa2pPUFFJQkJnZ3Foa2pPUFFNQkJ3TkNBQVNBbWg4Uy93cU4Kd2wybUt1UzVmaXM1eVlvdWNwZXZTUEVhTHdYem9hdUhnWDgwTDZpYVhpbW9WYXFRZURoQ2o0dThqQTV5OEFOenJOQ0UwTUhybDgzSgpvNElERGpDQ0F3b3dId1lEVlIwakJCZ3dGb0FVbFc5ZHpiMGI0ZWxBU2NuVTlEUE9BVmNMM2xRd2F3WURWUjBmQkdRd1lqQmdvRjZnClhJWmFhSFIwY0hNNkx5OWhjR2t1ZEhKMWMzUmxaSE5sY25acFkyVnpMbWx1ZEdWc0xtTnZiUzl6WjNndlkyVnlkR2xtYVdOaGRHbHYKYmk5Mk15OXdZMnRqY213L1kyRTljR3hoZEdadmNtMG1aVzVqYjJScGJtYzlaR1Z5TUIwR0ExVWREZ1FXQkJTR1U3WkRXbnpOQmhtMwpPV0RqYnZQMXIyUDhIakFPQmdOVkhROEJBZjhFQkFNQ0JzQXdEQVlEVlIwVEFRSC9CQUl3QURDQ0Fqc0dDU3FHU0liNFRRRU5BUVNDCkFpd3dnZ0lvTUI0R0NpcUdTSWI0VFFFTkFRRUVFUEVPeFZJYkNvSFV6ZTV4QVU2MUdSSXdnZ0ZsQmdvcWhraUcrRTBCRFFFQ01JSUIKVlRBUUJnc3Foa2lHK0UwQkRRRUNBUUlCQkRBUUJnc3Foa2lHK0UwQkRRRUNBZ0lCQkRBUUJnc3Foa2lHK0UwQkRRRUNBd0lCQXpBUQpCZ3NxaGtpRytFMEJEUUVDQkFJQkF6QVJCZ3NxaGtpRytFMEJEUUVDQlFJQ0FQOHdFUVlMS29aSWh2aE5BUTBCQWdZQ0FnRC9NQkFHCkN5cUdTSWI0VFFFTkFRSUhBZ0VBTUJBR0N5cUdTSWI0VFFFTkFRSUlBZ0VBTUJBR0N5cUdTSWI0VFFFTkFRSUpBZ0VBTUJBR0N5cUcKU0liNFRRRU5BUUlLQWdFQU1CQUdDeXFHU0liNFRRRU5BUUlMQWdFQU1CQUdDeXFHU0liNFRRRU5BUUlNQWdFQU1CQUdDeXFHU0liNApUUUVOQVFJTkFnRUFNQkFHQ3lxR1NJYjRUUUVOQVFJT0FnRUFNQkFHQ3lxR1NJYjRUUUVOQVFJUEFnRUFNQkFHQ3lxR1NJYjRUUUVOCkFRSVFBZ0VBTUJBR0N5cUdTSWI0VFFFTkFRSVJBZ0VMTUI4R0N5cUdTSWI0VFFFTkFRSVNCQkFFQkFNRC8vOEFBQUFBQUFBQUFBQUEKTUJBR0NpcUdTSWI0VFFFTkFRTUVBZ0FBTUJRR0NpcUdTSWI0VFFFTkFRUUVCakJnYWdBQUFEQVBCZ29xaGtpRytFMEJEUUVGQ2dFQgpNQjRHQ2lxR1NJYjRUUUVOQVFZRUVHV08wU2lPdHBGbDI0ZEZtT3lPVUs0d1JBWUtLb1pJaHZoTkFRMEJCekEyTUJBR0N5cUdTSWI0ClRRRU5BUWNCQVFIL01CQUdDeXFHU0liNFRRRU5BUWNDQVFFQU1CQUdDeXFHU0liNFRRRU5BUWNEQVFIL01Bb0dDQ3FHU000OUJBTUMKQTBnQU1FVUNJRGxqWDRBeDdTNDE1TEdjZG04czRucG14NU9zak4yMkFNMC9XV2hBY2MrdEFpRUE2M3N6ckJaWjZDUUI5ckFwZ3NHSgpMazVNQUVWZ1lwZ3J0blFoYmFxZytQTT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLS0tLS0tQkVHSU4gQ0VSVElGSUNBVEUtLS0tLQpNSUlDbGpDQ0FqMmdBd0lCQWdJVkFKVnZYYzI5RytIcFFFbkoxUFF6emdGWEM5NVVNQW9HQ0NxR1NNNDlCQU1DCk1HZ3hHakFZQmdOVkJBTU1FVWx1ZEdWc0lGTkhXQ0JTYjI5MElFTkJNUm93R0FZRFZRUUtEQkZKYm5SbGJDQkQKYjNKd2IzSmhkR2x2YmpFVU1CSUdBMVVFQnd3TFUyRnVkR0VnUTJ4aGNtRXhDekFKQmdOVkJBZ01Ba05CTVFzdwpDUVlEVlFRR0V3SlZVekFlRncweE9EQTFNakV4TURVd01UQmFGdzB6TXpBMU1qRXhNRFV3TVRCYU1IQXhJakFnCkJnTlZCQU1NR1VsdWRHVnNJRk5IV0NCUVEwc2dVR3hoZEdadmNtMGdRMEV4R2pBWUJnTlZCQW9NRVVsdWRHVnMKSUVOdmNuQnZjbUYwYVc5dU1SUXdFZ1lEVlFRSERBdFRZVzUwWVNCRGJHRnlZVEVMTUFrR0ExVUVDQXdDUTBFeApDekFKQmdOVkJBWVRBbFZUTUZrd0V3WUhLb1pJemowQ0FRWUlLb1pJemowREFRY0RRZ0FFTlNCLzd0MjFsWFNPCjJDdXpweHc3NGVKQjcyRXlER2dXNXJYQ3R4MnRWVExxNmhLazZ6K1VpUlpDbnFSN3BzT3ZncUZlU3hsbVRsSmwKZVRtaTJXWXozcU9CdXpDQnVEQWZCZ05WSFNNRUdEQVdnQlFpWlF6V1dwMDBpZk9EdEpWU3YxQWJPU2NHckRCUwpCZ05WSFI4RVN6QkpNRWVnUmFCRGhrRm9kSFJ3Y3pvdkwyTmxjblJwWm1sallYUmxjeTUwY25WemRHVmtjMlZ5CmRtbGpaWE11YVc1MFpXd3VZMjl0TDBsdWRHVnNVMGRZVW05dmRFTkJMbVJsY2pBZEJnTlZIUTRFRmdRVWxXOWQKemIwYjRlbEFTY25VOURQT0FWY0wzbFF3RGdZRFZSMFBBUUgvQkFRREFnRUdNQklHQTFVZEV3RUIvd1FJTUFZQgpBZjhDQVFBd0NnWUlLb1pJemowRUF3SURSd0F3UkFJZ1hzVmtpMHcraTZWWUdXM1VGLzIydWFYZTBZSkRqMVVlCm5BK1RqRDFhaTVjQ0lDWWIxU0FtRDV4a2ZUVnB2bzRVb3lpU1l4ckRXTG1VUjRDSTlOS3lmUE4rCi0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0KLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUNqekNDQWpTZ0F3SUJBZ0lVSW1VTTFscWROSW56ZzdTVlVyOVFHemtuQnF3d0NnWUlLb1pJemowRUF3SXcKYURFYU1CZ0dBMVVFQXd3UlNXNTBaV3dnVTBkWUlGSnZiM1FnUTBFeEdqQVlCZ05WQkFvTUVVbHVkR1ZzSUVOdgpjbkJ2Y21GMGFXOXVNUlF3RWdZRFZRUUhEQXRUWVc1MFlTQkRiR0Z5WVRFTE1Ba0dBMVVFQ0F3Q1EwRXhDekFKCkJnTlZCQVlUQWxWVE1CNFhEVEU0TURVeU1URXdORFV4TUZvWERUUTVNVEl6TVRJek5UazFPVm93YURFYU1CZ0cKQTFVRUF3d1JTVzUwWld3Z1UwZFlJRkp2YjNRZ1EwRXhHakFZQmdOVkJBb01FVWx1ZEdWc0lFTnZjbkJ2Y21GMAphVzl1TVJRd0VnWURWUVFIREF0VFlXNTBZU0JEYkdGeVlURUxNQWtHQTFVRUNBd0NRMEV4Q3pBSkJnTlZCQVlUCkFsVlRNRmt3RXdZSEtvWkl6ajBDQVFZSUtvWkl6ajBEQVFjRFFnQUVDNm5Fd01ESVlaT2ovaVBXc0N6YUVLaTcKMU9pT1NMUkZoV0dqYm5CVkpmVm5rWTR1M0lqa0RZWUwwTXhPNG1xc3lZamxCYWxUVll4RlAyc0pCSzV6bEtPQgp1ekNCdURBZkJnTlZIU01FR0RBV2dCUWlaUXpXV3AwMGlmT0R0SlZTdjFBYk9TY0dyREJTQmdOVkhSOEVTekJKCk1FZWdSYUJEaGtGb2RIUndjem92TDJObGNuUnBabWxqWVhSbGN5NTBjblZ6ZEdWa2MyVnlkbWxqWlhNdWFXNTAKWld3dVkyOXRMMGx1ZEdWc1UwZFlVbTl2ZEVOQkxtUmxjakFkQmdOVkhRNEVGZ1FVSW1VTTFscWROSW56ZzdTVgpVcjlRR3prbkJxd3dEZ1lEVlIwUEFRSC9CQVFEQWdFR01CSUdBMVVkRXdFQi93UUlNQVlCQWY4Q0FRRXdDZ1lJCktvWkl6ajBFQXdJRFNRQXdSZ0loQU9XLzVRa1IrUzlDaVNEY05vb3dMdVBSTHNXR2YvWWk3R1NYOTRCZ3dUd2cKQWlFQTRKMGxySG9NcytYbzVvL3NYNk85UVd4SFJBdlpVR09kUlE3Y3ZxUlhhcUk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
items:
format: uint8
type: integer
type: array
x-go-name: Quote
user_data:
description: User data - enclave held data
example: uJzueTbG8uTrkoBcSG7Duu2izGJ2lAZveRqx0E/exGnX81/4kJdU1Wh1FDkn0K8+
items:
format: uint8
type: integer
type: array
x-go-name: RuntimeData
type: object
x-go-package: intel/kbs/v1/model
KeyTransferResponse:
properties:
wrapped_key:
items:
format: uint8
type: integer
type: array
x-go-name: WrappedKey
wrapped_swk:
items:
format: uint8
type: integer
type: array
x-go-name: WrappedSWK
type: object
x-go-package: intel/kbs/v1/model
KeyUpdateRequest:
properties:
transfer_policy_id:
description: Universal Unique IDentifier of the Key Transfer Policy
example: 4110594b-a753-4457-7d7f-3e52b6252ed6
format: uuid
type: string
x-go-name: TransferPolicyID
required:
- transfer_policy_id
type: object
x-go-package: intel/kbs/v1/model
PublicKey:
description: |-
The value of the modulus N is considered secret by this library and protected
from leaking through timing side-channels. However, neither the value of the
exponent E nor the precise bit size of N are similarly protected.
properties:
E:
format: int64
type: integer
"N":
type: string
title: A PublicKey represents the public part of an RSA key.
type: object
x-go-package: crypto/rsa
SgxAttributes:
properties:
enforce_tcb_upto_date:
description: Should policy engine enforce TCB upto-date status as part of SGX Attestation
example: true
type: boolean
x-go-name: EnforceTCBUptoDate
isvprodid:
description: Product ID Specific to the workload running the SGX enclave
example: '[ 0001, 0002 ]'
items:
format: uint16
type: integer
type: array
x-go-name: IsvProductId
isvsvn:
description: The Security Version Number of the Enclave
example: 0
format: uint16
type: integer
x-go-name: IsvSvn
mrenclave:
description: Hash of the Contents of the SGX Enclave
example: ad46749ed41ebaa2327252041ee746d3791a9f2431830fee0883f7993caf316a
items:
type: string
type: array
x-go-name: MrEnclave
mrsigner:
description: Hash of the key used to sign the SGX Enclave
example: 83d719e77deaca1470f6baf62a4d774303c899db69020f9c70ee1dfc08c7ce9e
items:
type: string
type: array
x-go-name: MrSigner
type: object
x-go-package: intel/kbs/v1/model
SgxPolicy:
properties:
attributes:
$ref: '#/definitions/SgxAttributes'
policy_ids:
description: List of Policy IDs which are matched in ITA
example: '[ 4517534b-a758-4447-7d2f-3e5606152ed6, 34568456-2398-3875-7453-395766152ed6 ]'
items:
format: uuid
type: string
type: array
x-go-name: PolicyIds
type: object
x-go-package: intel/kbs/v1/model
TdxAttributes:
properties:
enforce_tcb_upto_date:
description: Should policy engine enforce TCB upto-date status as part of TDX Attestation
example: true
type: boolean
x-go-name: EnforceTCBUptoDate
mrseam:
description: Hash of the Contents of the TDX SEAM Module
example: 0f3b72d0f9606086d6a7800e7d50b82fa6cb5ec64c7210353a0696c1eef343679bf5b9e8ec0bf58ab3fce10f2c166ebe
items:
type: string
type: array
x-go-name: MrSeam
mrsignerseam:
description: Hash of the key used to sign the TDX SEAM Module
example: 83d719e77deaca1470f6baf62a4d774303c899db69020f9c70ee1dfc08c7ce9e
items:
type: string
type: array
x-go-name: MrSignerSeam
mrtd:
description: SHA-384 measurement of a TD, accumulated during TD build.
example: df656414fc0f49b23e2ae64b6f23b82901e2206aab36b671e360ebd414899dab51bbb60134bbe6ad8dcc70b995d9dc50
items:
type: string
type: array
x-go-name: MRTD
rtmr0:
description: A SHA-384 measurement register that can be updated during TD run-time
example: b90abd43736381b12fc9b038924c73e31c8371674905e7fcb7941d69fe59d30eda3adb9e41b878151e756fb05ad13d14
type: string
x-go-name: RTMR0
rtmr1:
description: A SHA-384 measurement register that can be updated during TD run-time
example: a53c98b16f0de470338e7f072d9c5fcef6171327ec6c78b842e637251b1de6e37354c47fb68de27ef14bb67caf288d9b
type: string
x-go-name: RTMR1
rtmr2:
description: A SHA-384 measurement register that can be updated during TD run-time
example: "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
type: string
x-go-name: RTMR2
rtmr3:
description: A SHA-384 measurement register that can be updated during TD run-time
example: "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
type: string
x-go-name: RTMR3
seamsvn:
description: The Security Version Number of the TDX SEAM Module calculated as majorVersion x 256 + minorVersion
example: 258
format: uint16
type: integer
x-go-name: SeamSvn
type: object
x-go-package: intel/kbs/v1/model
TdxPolicy:
properties:
attributes:
$ref: '#/definitions/TdxAttributes'
policy_ids:
description: List of Policy IDs which are matched in ITA
example: '[ 4517534b-a758-4447-7d2f-3e5606152ed6, 34568456-2398-3875-7453-395766152ed6 ]'
items:
format: uuid
type: string
type: array
x-go-name: PolicyIds
type: object
x-go-package: intel/kbs/v1/model
TransferKeyRequest:
properties:
AttestationType:
type: string
KeyId:
format: uuid
type: string
KeyTransferRequest:
$ref: '#/definitions/KeyTransferRequest'
PublicKey:
$ref: '#/definitions/PublicKey'
type: object
x-go-package: intel/kbs/v1/service
TransferKeyResponse:
properties:
AttestationType:
type: string
KeyTransferResponse:
$ref: '#/definitions/KeyTransferResponse'
Nonce:
$ref: '#/definitions/VerifierNonce'
type: object
x-go-package: intel/kbs/v1/service
User:
properties:
password:
example: testPassword
type: string
x-go-name: Password
permissions:
description: Roles associated with an user
example:
- users:create
- users:search
items:
type: string
type: array
x-go-name: Permissions
username:
example: testUser
type: string
x-go-name: Username
required:
- username
- password
- permissions
type: object
x-go-package: intel/kbs/v1/model
UserResponse:
properties:
created_at:
description: Asset creation time
example: "0001-01-01T00:00:00Z"
format: date-time
type: string
x-go-name: CreatedAt
id:
description: Universal Unique IDentifier of the user
example: 8170574b-a783-4357-747f-3e52922f2ed8
format: uuid
type: string
x-go-name: ID
permissions:
description: Roles associated with an user
example:
- users:create
- users:search
items:
type: string
type: array
x-go-name: Permissions
updated_at:
description: Asset modification time
example: "0001-01-01T00:00:00Z"
format: date-time
type: string
x-go-name: UpdatedAt
username:
description: Specified Username for whom User ID is created
example: testUser
type: string
x-go-name: Username
type: object
x-go-package: intel/kbs/v1/model
VerifierNonce:
description: VerifierNonce holds the signed nonce issued from Intel Trust Authority
properties:
iat:
items:
format: uint8
type: integer
type: array
x-go-name: Iat
signature:
items:
format: uint8
type: integer
type: array
x-go-name: Signature
val:
items:
format: uint8
type: integer
type: array
x-go-name: Val
type: object
x-go-package: github.com/intel/trustauthority-client/go-connector
host: kbs.com:9443
info:
description: |-
The Key Broker Service (KBS) acts as a bridge between an existing ecosystem of key management service (KMS) and a client requesting keys, by evaluating additional “key transfer policy”. This key transfer policy can enforce a client to go through attestation demonstrating it is running in a trusted execution environment (TEE) such as Intel SGX or TDX or on a trusted platform. Attestation can be provided by Intel Trust Authority (ITA). Key broker service is a relying parity (RP) as defined in IETF RATs specification.
The key Broker Service (KBS) provides and retains encryption/decryption keys for various purposes. When a TEE workload requests for the decryption key to operate on a resource, the KBS requests the workloads attestation from Intel Trust Authority (ITA), verifies all digital signatures and retains the final control over whether the decryption key is issued. If the workload's attestation meets the policy requirements, the KBS issues a decryption key itself, wrapped using the public key form the workload that was attested, cryptographically ensuring that only the attested workload can decrypt the requested key.
license:
name: Copyright(C) 2022 Intel Corporation. All Rights Reserved.
title: Key Broker Service
version: 0.3.1
paths:
/key-transfer-policies:
get:
description: |
Searches for key transfer policies.
Returns - The collection of serialized KeyTransferPolicy Go struct objects.
operationId: SearchKeyTransferPolicies
parameters:
- description: Accept header
enum:
- application/json
in: header
name: Accept
required: true
type: string
produces:
- application/json
responses:
"200":
description: Successfully retrieved the key transfer policies.
schema:
$ref: '#/definitions/KeyTransferPolicies'
"400":
description: Invalid values for request params
"401":
description: Request Unauthorized
"415":
description: Invalid Accept Header in Request
"500":
description: Internal server error
security:
- bearerToken: []
tags:
- KeyTransferPolicies
x-permissions: key-transfer-policies:search
x-sample-call-endpoint: https://kbs.com:9443/kbs/v1/key-transfer-policies
x-sample-call-output: |-
[
{
"id": "d0c3f191-80f9-408f-a690-0dde00ba65ac",
"created_at": "2021-08-20T06:30:35.085644391Z",
"attestation_type": "SGX",
"sgx": {
"attributes": {
"mrsigner": [
"cd171c56941c6ce49690b455f691d9c8a04c2e43e0a4d30f752fa5285c7ee57f"
],
"isvprodid": [
12
],
"mrenclave": [
"01c60b9617b2f96e53cb75ef01e0dccea3afc7b7992697eabb8f714b2ccd1953"
],
"isvsvn": 1,
"enforce_tcb_upto_date": false
},
"policy_ids": [
"37965f5f-ccaf-4cdc-a356-a8ed5268a5bf",
"9846bf40-e380-4842-ae15-1b60996d1190"
]
}
},
{
"id": "cf9adfcf-4bfa-4653-b9b8-2b94beca768f",
"created_at": "2021-08-20T05:51:39.588320016Z",
"attestation_type": "TDX",
"tdx": {
"attributes": {
"mrsignerseam": [
"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
],
"mrseam": [
"0f3b72d0f9606086d6a7800e7d50b82fa6cb5ec64c7210353a0696c1eef343679bf5b9e8ec0bf58ab3fce10f2c166ebe"
],
"seamsvn": 258,
"mrtd": [
"cf656414fc0f49b23e2ae64b6f23b82901e2206aab36b671e360ebd414899dab51bbb60134bbe6ad8dcc70b995d9dc50"
],
"rtmr0": "b90abd43736381b12fc9b038924c73e31c8371674905e7fcb7941d69fe59d30eda3adb9e41b878151e756fb05ad13d14",
"rtmr1": "a53c98b16f0de470338e7f072d9c5fcef6171327ec6c78b842e637251b1de6e37354c47fb68de27ef14bb67caf288d9b",
"rtmr2": "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"rtmr3": "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"enforce_tcb_upto_date": false
},
"policy_ids": [
"37965f5f-ccaf-4cdc-a356-a8ed5268a5bf",
"9846bf40-e380-4842-ae15-1b60996d1190"
]
}
}
]
post:
consumes:
- application/json
description: |
Creates a key transfer policy. Only one SGX or TDX key transfer policy can be created at a time. A key
transfer policy can be created in the following ways: by providing a list of policy-ids, by providing TDX or SGX attributes, or by providing both a list of policy-ids and TDX or SGX attributes.
The serialized KeyTransferPolicy Go struct object represents the content of the request body.
| Attribute | Description |
|----------------------------------------------|-------------|
| attestation_type | An array of attestation-type identifiers that the client must support to get the key. The client must advertise these with the key request, e.g., "SGX," or "TDX." Note that if the key server needs to restrict technologies, it must list technologies that can receive the key. |
| mrsigner | An array of measurements of the SGX enclave’s code signing certificate. This is mandatory. The same issuer must be added as a trusted certificate in key server configuration settings. |
| isvprodid | An array of (16-bit value) (ISVPRODID). This is mandatory. This is similar to a qualifier for the issuer, so the same issuer (code signing) key can sign separate products. |
| mrenclave | An array of enclave measurements that are allowed to retrieve the key (MRENCLAVE). The client must have one of these measurements in the SGX quote. This supports the use case of providing a key only to an SGX enclave that locally enforces the key usage policy. |
| isvsvn | Minimum security version number required for Enclave. |
| mrsignerseam | An array of measurements of seam module issuer. This is mandatory. |
| mrseam | An array of measurements of seam module. This is mandatory. |
| mrtd | A array of TD measurements. |
| rtmr0 | The measurement extended to RTMR0. |
| rtmr1 | The measurement extended to RTMR1. |
| rtmr2 | The measurement extended to RTMR2. |
| rtmr3 | The measurement extended to RTMR3. |
| seamsvn | The minimum security version number of seam module. |
| enforce_tcb_upto_date | The boolean value to enforce an up-to-date TCB. |
| policy_ids | A array of TD/Enclave Attestation Policy Ids. |
operationId: CreateKeyTransferPolicy
parameters:
- in: body
name: request body
required: true
schema:
$ref: '#/definitions/KeyTransferPolicy'
- description: Content-Type header.
enum:
- application/json
in: header
name: Content-Type
required: true
type: string
- description: Accept header.
enum:
- application/json
in: header
name: Accept
required: true
type: string
produces:
- application/json
responses:
"201":
description: Successfully created the key transfer policy.
schema:
$ref: '#/definitions/KeyTransferPolicy'
"400":
description: An invalid request body was provided.
"401":
description: The request was unauthorized.
"415":
description: Invalid Accept Header in the request.
"500":
description: Internal server error.
security:
- bearerToken: []
tags:
- KeyTransferPolicies
x-permissions: key-transfer-policies:create
x-sample-call-endpoint: https://kbs.com:9443/kbs/v1/key-transfer-policies
x-sgx-sample-call-input: |
{
"attestation_type": "SGX",
"sgx": {
"attributes": {
"mrsigner": ["cd171c56941c6ce49690b455f691d9c8a04c2e43e0a4d30f752fa5285c7ee57f"],
"isvprodid": [12],
"mrenclave": ["01c60b9617b2f96e53cb75ef01e0dccea3afc7b7992697eabb8f714b2ccd1953"],
"isvsvn": 1,
"enforce_tcb_upto_date": false
},
"policy_ids": ["37965f5f-ccaf-4cdc-a356-a8ed5268a5bf", "9846bf40-e380-4842-ae15-1b60996d1190"]
}
}
x-sgx-sample-call-output: |
{
"id": "d0c3f191-80f9-408f-a690-0dde00ba65ac",
"created_at": "2021-08-20T06:30:35.085644391Z",
"attestation_type": "SGX",
"sgx": {
"attributes": {
"mrsigner": [
"cd171c56941c6ce49690b455f691d9c8a04c2e43e0a4d30f752fa5285c7ee57f"
],
"isvprodid": [
12
],
"mrenclave": [
"01c60b9617b2f96e53cb75ef01e0dccea3afc7b7992697eabb8f714b2ccd1953"
],
"isvsvn": 1,
"enforce_tcb_upto_date": false
},
"policy_ids": [
"37965f5f-ccaf-4cdc-a356-a8ed5268a5bf",
"9846bf40-e380-4842-ae15-1b60996d1190"
]
}
}
x-tdx-sample-call-input: |
{
"attestation_type": "TDX",
"tdx": {
"attributes": {
"mrsignerseam": [
"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
],
"mrseam": [
"0f3b72d0f9606086d6a7800e7d50b82fa6cb5ec64c7210353a0696c1eef343679bf5b9e8ec0bf58ab3fce10f2c166ebe"
],
"mrtd": [
"cf656414fc0f49b23e2ae64b6f23b82901e2206aab36b671e360ebd414899dab51bbb60134bbe6ad8dcc70b995d9dc50"
],
"rtmr0": "b90abd43736381b12fc9b038924c73e31c8371674905e7fcb7941d69fe59d30eda3adb9e41b878151e756fb05ad13d14",
"rtmr1": "a53c98b16f0de470338e7f072d9c5fcef6171327ec6c78b842e637251b1de6e37354c47fb68de27ef14bb67caf288d9b",
"rtmr2": "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"rtmr3": "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"seamsvn": 258,
"enforce_tcb_upto_date": false
},
"policy_ids": [
"37965f5f-ccaf-4cdc-a356-a8ed5268a5bf", "9846bf40-e380-4842-ae15-1b60996d1190"
]
}
}
x-tdx-sample-call-output: |-
{
"id": "cf9adfcf-4bfa-4653-b9b8-2b94beca768f",
"created_at": "2021-08-20T05:51:39.588320016Z",
"attestation_type": "TDX",
"tdx": {
"attributes": {
"mrsignerseam": [
"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
],
"mrseam": [
"0f3b72d0f9606086d6a7800e7d50b82fa6cb5ec64c7210353a0696c1eef343679bf5b9e8ec0bf58ab3fce10f2c166ebe"
],
"seamsvn": 258,
"mrtd": [
"cf656414fc0f49b23e2ae64b6f23b82901e2206aab36b671e360ebd414899dab51bbb60134bbe6ad8dcc70b995d9dc50"
],
"rtmr0": "b90abd43736381b12fc9b038924c73e31c8371674905e7fcb7941d69fe59d30eda3adb9e41b878151e756fb05ad13d14",
"rtmr1": "a53c98b16f0de470338e7f072d9c5fcef6171327ec6c78b842e637251b1de6e37354c47fb68de27ef14bb67caf288d9b",
"rtmr2": "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"rtmr3": "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"enforce_tcb_upto_date": false
},
"policy_ids": [
"37965f5f-ccaf-4cdc-a356-a8ed5268a5bf",
"9846bf40-e380-4842-ae15-1b60996d1190"
]
}
}
/key-transfer-policies/{id}:
delete:
description: |
Deletes a key transfer policy.
operationId: DeleteKeyTransferPolicy
parameters:
- description: Unique ID of the key transfer policy.
format: uuid
in: path
name: id
required: true
type: string
responses:
"204":
description: Successfully deleted the key transfer policy.
"401":
description: Request Unauthorized
"404":
description: KeyTransferPolicy record not found
"500":
description: Internal server error
security:
- bearerToken: []
tags:
- KeyTransferPolicies
x-permissions: key-transfer-policies:delete
x-sample-call-endpoint: https://kbs.com:9443/kbs/v1/key-transfer-policies/75d34bf4-80fb-4ca5-8602-a8d82e56b30d
get:
description: |
Retrieves a key transfer policy.
Returns - The serialized KeyTransferPolicy Go struct object that was retrieved.
operationId: RetrieveKeyTransferPolicy
parameters:
- description: Unique ID of the key transfer policy.
format: uuid
in: path
name: id
required: true
type: string
- description: Accept header
enum:
- application/json
in: header
name: Accept
required: true
type: string
produces:
- application/json
responses:
"200":
description: Successfully retrieved the key transfer policy.
schema:
$ref: '#/definitions/KeyTransferPolicy'
"401":
description: Request Unauthorized
"404":
description: KeyTransferPolicy record not found
"415":
description: Invalid Accept Header in Request
"500":
description: Internal server error
security:
- bearerToken: []
tags:
- KeyTransferPolicies
x-permissions: key-transfer-policies:search
x-sample-call-endpoint: https://kbs.com:9443/kbs/v1/key-transfer-policies/75d34bf4-80fb-4ca5-8602-a8d82e56b30d
x-sample-call-output: |-
{
"id": "75d34bf4-80fb-4ca5-8602-a8d82e56b30d",
"created_at": "2021-08-20T05:51:39.588320016Z",
"attestation_type": "TDX",
"tdx": {
"attributes": {
"mrsignerseam": [
"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
],
"mrseam": [
"0f3b72d0f9606086d6a7800e7d50b82fa6cb5ec64c7210353a0696c1eef343679bf5b9e8ec0bf58ab3fce10f2c166ebe"
],
"seamsvn": 258,
"mrtd": [
"cf656414fc0f49b23e2ae64b6f23b82901e2206aab36b671e360ebd414899dab51bbb60134bbe6ad8dcc70b995d9dc50"
],
"rtmr0": "b90abd43736381b12fc9b038924c73e31c8371674905e7fcb7941d69fe59d30eda3adb9e41b878151e756fb05ad13d14",
"rtmr1": "a53c98b16f0de470338e7f072d9c5fcef6171327ec6c78b842e637251b1de6e37354c47fb68de27ef14bb67caf288d9b",
"rtmr2": "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"rtmr3": "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"enforce_tcb_upto_date": false
},
"policy_ids": [
"37965f5f-ccaf-4cdc-a356-a8ed5268a5bf",
"9846bf40-e380-4842-ae15-1b60996d1190"
]
}
}
/keys:
get:
description: |
Searches for keys. At least one of the query parameters must be provided.
Returns - The collection of serialized KeyResponse Go struct objects.
operationId: SearchKey
parameters:
- description: Key algorithm.
enum:
- AES
- RSA
- EC
- aes
- rsa
- ec
in: query
name: algorithm
type: string
- description: Key length.
enum:
- 128
- 192
- 256
- 2048
- 3072
- 4096
- 7680
in: query
name: keyLength
type: integer
- description: Elliptic Curve name.
enum:
- secp256r1
- secp384r1
- secp521r1
- prime256v1
in: query
name: curveType
type: string
- description: Unique identifier of the transfer policy.
format: uuid
in: query
name: transferPolicyId
type: string
- description: Accept header
enum:
- application/json
in: header
name: Accept
required: true
type: string
produces:
- application/json
responses:
"200":
description: Successfully retrieved the keys.
schema:
$ref: '#/definitions/KeyResponses'
"400":
description: Invalid values for request params
"401":
description: Request Unauthorized
"415":
description: Invalid Accept Header in Request
"500":
description: Internal server error
security:
- bearerToken: []
tags:
- Keys
x-permissions: keys:search
x-sample-call-endpoint: https://kbs.com:9443/kbs/v1/keys?algorithm=aes
x-sample-call-output: |-
[
{
"key_information": {
"id": "fc0cc779-22b6-4741-b0d9-e2e69635ad1e",
"algorithm": "AES",
"key_length": 256
},
"transfer_policy_id": "3ce27bbd-3c5f-4b15-8c0a-44310f0f83d9",
"transfer_link": "/kbs/v1/keys/fc0cc779-22b6-4741-b0d9-e2e69635ad1e/transfer",
"created_at": "2020-09-23T11:16:26.738467277Z"
}
]
post:
consumes:
- application/json
description: |
Creates or registers a key.
The serialized KeyRequest Go struct object represents the content of the request body.
| Attribute | Description |
|--------------------|-------------|
| key_information | A JSON object containing all the required information about a key. |
| transfer_policy_id | The unique identifier of the transfer policy to be applied to this key. |
The serialized KeyInformation Go struct object represents the content of the key_information field.
| Attribute | Description |
|-------------|-------------|
| algorithm | The encryption algorithm used to create or register a key. The supported algorithms are AES, RSA, and EC. |
| key_length | The key length used to create a key. Supported key lengths are 128,192,256 bits for AES and 2048,3072,4096,7680 bits for RSA. This parameter must be provided only for the AES and RSA algorithms. |
| curve_type | The elliptic curve used to create a key. The supported curves are secp256r1, secp384r1, prime256v1 and secp521r1. This parameter must be provided only for the EC algorithm. |
| key_data | The Base64 encoded private key to be registered. It is only supported if the key is created locally. |
| kmip_key_id | The unique KMIP identifier of the key to be registered. It is only supported if the key is created on a KMIP server. |
operationId: CreateKey
parameters:
- in: body
name: request body
required: true
schema:
$ref: '#/definitions/KeyRequest'
- description: Content-Type header.
enum:
- application/json
in: header
name: Content-Type
required: true
type: string
- description: Accept header.
enum:
- application/json
in: header
name: Accept
required: true
type: string
produces:
- application/json
responses:
"201":
description: The key was successfully created or registered.
schema:
$ref: '#/definitions/KeyResponse'
"400":
description: An invalid request body was provided.
"401":
description: The request was unauthorized.
"415":
description: Invalid Accept Header in the request.
"500":
description: Internal server error.
security:
- bearerToken: []
tags:
- Keys
x-permissions: keys:create
x-sample-call-endpoint: https://kbs.com:9443/kbs/v1/keys
x-sample-call-input: |
{
"key_information": {
"algorithm": "AES",
"key_length": 256
}
}
x-sample-call-output: |-
{
"key_information": {
"id": "fc0cc779-22b6-4741-b0d9-e2e69635ad1e",
"algorithm": "AES",
"key_length": 256
},
"transfer_policy_id": "3ce27bbd-3c5f-4b15-8c0a-44310f0f83d9",
"transfer_link": "/kbs/v1/keys/fc0cc779-22b6-4741-b0d9-e2e69635ad1e/transfer",
"created_at": "2020-09-23T11:16:26.738467277Z"
}
/keys/{id}:
delete:
description: |
Deletes a key.
operationId: DeleteKey
parameters:
- description: Unique ID of the key.
format: uuid
in: path
name: id
required: true
type: string
responses:
"204":
description: The key was successfully deleted.
"401":
description: Request Unauthorized.
"404":
description: The key record was not found.
"500":
description: Internal server error.
security:
- bearerToken: []
tags:
- Keys
x-permissions: keys:delete
x-sample-call-endpoint: https://kbs.com:9443/kbs/v1/keys/fc0cc779-22b6-4741-b0d9-e2e69635ad1e
get:
description: |
Retrieves a key.
Returns - The serialized KeyResponse Go struct object that was retrieved.
operationId: RetrieveKey
parameters:
- description: The unique ID of the key.
format: uuid