forked from confidential-containers/trustee
-
Notifications
You must be signed in to change notification settings - Fork 1
/
kbs.yaml
393 lines (371 loc) · 10.6 KB
/
kbs.yaml
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
openapi: 3.1.0
info:
title: Key Broker Service (KBS) API
description: HTTP based API for describing the communication between a Key
Broker Client (KBC) in a confidential guest and a trusted Key
Broker Service.
version: 0.1.0
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://<kbs>/kbs/v0
paths:
/auth:
post:
operationId: attestationAuth
summary: Initiate an attestation authentication
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Request'
responses:
200:
description: >-
The KBS attestation challenge.
The KBS session ID is returned in a cookie named `kbs-session-id`.
headers:
Set-Cookie:
schema:
type: string
example: kbs-session-id=1234
content:
application/json:
schema:
$ref: '#/components/schemas/Challenge'
400:
description: The request content or format is not supported
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInformation'
/attest:
post:
operationId: attestationEvidence
summary: Send an attestation evidence and receive an attestation results token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Attestation'
parameters:
- in: cookie
name: kbs-session-id
schema:
type: string
responses:
200:
description: The attestation evidence is authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/AttestationToken'
401:
description: Missing or invalid session ID
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInformation'
/attestation-policy:
post:
operationId: setAttestationPolicy
summary: Set attestation verification policy
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AttestationPolicy'
/resource-policy:
post:
operationId: setResourcePolicy
summary: Set resource distribution policy
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ResourcePolicy'
/resource/{repository}/{type}/{tag}:
get:
operationId: getResource
summary: Get a secret resource from the Key Broker Service.
parameters:
- in: cookie
name: kbs-session-id
schema:
type: string
required: false
- name: repository
in: path
description: A parent path of resource, can be empty to use the default repository.
schema:
type: string
required: false
- name: type
in: path
description: Resource type name
schema:
type: string
required: true
- name: tag
in: path
description: Resource instance tag
schema:
type: string
required: true
responses:
200:
description: >-
The KBS reponse including the resource.
The KBS session ID is returned in a cookie named `kbs-session-id`.
headers:
Set-Cookie:
schema:
type: string
example: kbs-session-id=1234
content:
application/jwe:
schema:
$ref: '#/components/schemas/Response'
401:
description: Missing or invalid session ID
403:
description: The KBC is not allowed to get that resource
404:
description: The requested resource does not exist
post:
operationId: registerSecretResource
summary: Register a secret resource into the Key Broker Service.
requestBody:
required: true
content: '*'
parameters:
- name: repository
in: path
description: A parent path of resource, can be empty to use the default repository.
schema:
type: string
required: false
- name: type
in: path
description: Resource type name
schema:
type: string
required: true
- name: tag
in: path
description: Resource instance tag
schema:
type: string
required: true
components:
schemas:
Request:
required:
- version
- tee
type: object
properties:
version:
type: string
tee:
type: string
enum: [amd-sev, intel-sgx, intel-tdx]
extra-params:
description: >-
Freely formatted JSON object used for HW-TEE specific attestation
processes.
type: object
description: KBC attestation authentication request
Challenge:
required:
- nonce
type: object
properties:
nonce:
type: string
extra-params:
description:
Freely formatted JSON object used for HW-TEE specific attestation
processes.
type: object
description:
KBS attestation challenge, sent in response to the KBC Request.
Attestation:
required:
- tee-pubkey
- tee-evidence
type: object
properties:
tee-pubkey:
$ref: '#/components/schemas/PublicKey'
tee-evidence:
description: HW-TEE specific attestation evidence.
type: object
description: >-
KBS attestation challenge, sent in response to the KBC Request.
Response:
required:
- protected
- encrypted_key
- iv
- ciphertext
type: object
properties:
protected:
description: A Base64-url encoding of '#/components/schemas/KeyHeader'
type: string
ciphertext:
type: string
description: A Base64-url encoding of the encrypted reponse data.
encrypted_key:
type: string
description: >-
A Base64-url encoding of the encrypted key used for encrypting the
response data.
iv:
type: string
description: >-
A Base64-url encoding of the encryption algorithm initialisation
vector.
tag:
type: string
description: >-
A JSON Web Encryption (https://www.rfc-editor.org/rfc/rfc7516)
formatted object.
KeyHeader:
required:
- alg
- enc
properties:
alg:
type: string
description: The signature algorithm
enc:
type: string
description: >-
Encryption algorithm used to encrypt the response payload.
AttestationPolicy:
required:
- type
- policy_id
- policy
properties:
type:
type: string
description: >-
Policy Engine type, for example: "opa"
policy_id:
type: string
description: >-
ID used to identify the policy, use "default" to set default policy
policy:
type: string
description: >-
Base64 encoded attestation verification policy.
ResourcePolicy:
required:
- policy
properties:
policy:
type: string
description: >-
Base64 encoded resource distribution policy.
AttestationToken:
required:
- token
type: object
properties:
token:
type: string
description: >-
A serialized JSON Web Token (https://jwt.io).
The token value is a string, which is made of 3 strings, separated
by dots.
The first string is a Base64-url encoding of
'#/components/schemas/AttestationTokenHeader'.
The second string is a Base64-url encoding of
'#/components/schemas/AttestationTokenPayload'.
The third string is a Base64-url encoding of the token signature.
AttestationTokenHeader:
required:
- typ
- alg
properties:
typ:
enum: [JWT]
type: string
description: The JWS header type. This must be `JWT`.
alg:
type: string
description: The signature algorithm
AttestationTokenPayload:
required:
- ext
- iat
- iss
- jwk
- tee-pubkey
- tcb-status
- evaluation-report
properties:
ext:
type: integer
description: The token expiration date, in seconds since the Epoch.
iat:
type: integer
description: The token issuing time, in seconds since the Epoch.
iss:
type: string
description: The token issuer URL.
jwk:
type: string
description: >-
A JSON Web Key (https://www.rfc-editor.org/rfc/rfc7517) formatted RSA Public Key for token signature verification.
tee-pubkey:
$ref: '#/components/schemas/PublicKey'
tcb-status:
type: string
description: Parsed claims from TEE evidence.
evaluation-report:
type: string
description: Evaluation report of TEE evidence.
PublicKey:
required:
- kty
- alg
- n
- e
properties:
kty:
type: stinrg
description: Key Type
alg:
type: string
description: Key Algorithm
n:
type: string
description: Key modulus
e:
type: string
description: Key exponent
description: >-
A JSON Web Key (https://www.rfc-editor.org/rfc/rfc7517) formatted RSA Public Key.
ErrorInformation:
required:
- type
- detail
properties:
type:
description: >-
https://github.com/confidential-containers/kbs/errors/<problem-type>
type: string
detail:
type: string
description: >-
A Problem Details for HTTP APIs (https://www.rfc-editor.org/rfc/rfc7807)
formatted payload.