Skip to content

Commit 00bd4d8

Browse files
smo4201smo4201
committed
doc: updated documentation
Signed-off-by: Simon Ott <simon.ott@aisec.fraunhofer.de>
1 parent 92f7228 commit 00bd4d8

17 files changed

+259
-150
lines changed

‎README.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,10 @@ An overview of the architecture is given in [Architecture](./doc/architecture.md
5050
Detailed information on how to generate, sign and parse metadata is given in
5151
[Metadata](./doc/metadata.md).
5252

53-
### APIs and Protocols
53+
### Developer Documentation
5454

55-
For a description of the `cmcd` gRPC, CoaP and socket APIs, refer to [CMCD API](./doc/cmcd-api.md).
56-
For a description of the attested TLS attestation protocol, refer to
57-
[Attestation Protocol](./doc/attestation-protocol.md).
58-
59-
### Integration
60-
61-
Usually, the attested TLS or HTTPS libraries are used within own projects to provide attestation
62-
for TLS or HTTPS connections, as described in [Integration](./doc/go-integration.md)
55+
Refer to [Developer Documentation](./doc/dev.md) for instructions on developing custom applications
56+
using attested TLS or attested HTTPS, as well as for developing the CMC.
6357

6458
### Additional Demo Setups
6559

‎doc/api/json/api/MeasureRequest.json‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -348,10 +348,6 @@
348348
"uefidevicepath"
349349
]
350350
},
351-
"Int": {
352-
"properties": {},
353-
"type": "object"
354-
},
355351
"IntelCollateral": {
356352
"properties": {
357353
"TcbInfo": {
@@ -1016,23 +1012,29 @@
10161012
"sha256": {
10171013
"$ref": "#/$defs/HexByte"
10181014
},
1015+
"sha384": {
1016+
"$ref": "#/$defs/HexByte"
1017+
},
1018+
"sha512": {
1019+
"$ref": "#/$defs/HexByte"
1020+
},
10191021
"eventname": {
10201022
"type": "string"
10211023
},
10221024
"eventdata": {
10231025
"$ref": "#/$defs/EventData"
10241026
},
1027+
"description": {
1028+
"type": "string"
1029+
},
10251030
"ctrData": {
10261031
"$ref": "#/$defs/CtrData"
10271032
},
10281033
"intelCollateral": {
10291034
"$ref": "#/$defs/IntelCollateral"
10301035
}
10311036
},
1032-
"type": "object",
1033-
"required": [
1034-
"sha256"
1035-
]
1037+
"type": "object"
10361038
},
10371039
"MeasureRequest": {
10381040
"properties": {
@@ -1758,7 +1760,7 @@
17581760
"type": "integer"
17591761
},
17601762
"serialNumber": {
1761-
"$ref": "#/$defs/Int"
1763+
"type": "string"
17621764
},
17631765
"issuer": {
17641766
"$ref": "#/$defs/X509Name"

‎doc/api/json/api/VerificationRequest.json‎

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,6 @@
2222
},
2323
"type": "object"
2424
},
25-
"metadataCas": {
26-
"items": {
27-
"type": "string",
28-
"contentEncoding": "base64"
29-
},
30-
"type": "array"
31-
},
32-
"identityCas": {
33-
"items": {
34-
"type": "string",
35-
"contentEncoding": "base64"
36-
},
37-
"type": "array"
38-
},
3925
"peer": {
4026
"type": "string"
4127
},
@@ -54,9 +40,7 @@
5440
"required": [
5541
"version",
5642
"nonce",
57-
"report",
58-
"metadataCas",
59-
"identityCas"
43+
"report"
6044
]
6145
}
6246
}

‎doc/api/json/api/VerificationResponse.json‎

Lines changed: 72 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -499,10 +499,6 @@
499499
"uefidevicepath"
500500
]
501501
},
502-
"Int": {
503-
"properties": {},
504-
"type": "object"
505-
},
506502
"Linux": {
507503
"properties": {
508504
"uidMappings": {
@@ -1215,8 +1211,11 @@
12151211
"certLevel": {
12161212
"type": "integer"
12171213
},
1218-
"caFingerprint": {
1219-
"type": "string"
1214+
"caFingerprints": {
1215+
"items": {
1216+
"type": "string"
1217+
},
1218+
"type": "array"
12201219
},
12211220
"snpPolicy": {
12221221
"$ref": "#/$defs/SnpPolicy"
@@ -1274,7 +1273,7 @@
12741273
},
12751274
"type": "object"
12761275
},
1277-
"result": {
1276+
"summary": {
12781277
"$ref": "#/$defs/Result"
12791278
},
12801279
"validityCheck": {
@@ -1294,33 +1293,40 @@
12941293
"version",
12951294
"validity",
12961295
"SgxValues",
1297-
"result",
1296+
"summary",
12981297
"signatureValidation"
12991298
]
13001299
},
13011300
"MetadataSummary": {
13021301
"properties": {
1303-
"deviceDescValidation": {
1302+
"devDescResult": {
13041303
"$ref": "#/$defs/MetadataResult"
13051304
},
1306-
"manifestValidation": {
1305+
"manifestResults": {
13071306
"items": {
13081307
"$ref": "#/$defs/MetadataResult"
13091308
},
13101309
"type": "array"
13111310
},
1312-
"companyValidation": {
1311+
"compDescResult": {
13131312
"$ref": "#/$defs/MetadataResult"
13141313
},
1315-
"compatibilityValidation": {
1314+
"unknownResults": {
1315+
"items": {
1316+
"$ref": "#/$defs/MetadataResult"
1317+
},
1318+
"type": "array"
1319+
},
1320+
"compatibilityResult": {
13161321
"$ref": "#/$defs/CompatibilityResult"
13171322
}
13181323
},
13191324
"type": "object",
13201325
"required": [
1321-
"deviceDescValidation",
1322-
"manifestValidation",
1323-
"compatibilityValidation"
1326+
"devDescResult",
1327+
"manifestResults",
1328+
"unknownResults",
1329+
"compatibilityResult"
13241330
]
13251331
},
13261332
"Mount": {
@@ -1541,7 +1547,7 @@
15411547
},
15421548
"QeReportResult": {
15431549
"properties": {
1544-
"success": {
1550+
"summary": {
15451551
"$ref": "#/$defs/Result"
15461552
},
15471553
"mrsigner": {
@@ -1565,7 +1571,7 @@
15651571
},
15661572
"type": "object",
15671573
"required": [
1568-
"success",
1574+
"summary",
15691575
"mrsigner",
15701576
"isvProdId",
15711577
"miscSelect",
@@ -1613,8 +1619,8 @@
16131619
},
16141620
"Result": {
16151621
"properties": {
1616-
"success": {
1617-
"type": "boolean"
1622+
"status": {
1623+
"type": "string"
16181624
},
16191625
"got": {
16201626
"type": "string"
@@ -1634,13 +1640,19 @@
16341640
},
16351641
"type": "array"
16361642
},
1637-
"errorCode": {
1638-
"type": "integer"
1643+
"errorCodes": {
1644+
"items": {
1645+
"type": "integer"
1646+
},
1647+
"type": "array"
1648+
},
1649+
"details": {
1650+
"type": "string"
16391651
}
16401652
},
16411653
"type": "object",
16421654
"required": [
1643-
"success"
1655+
"status"
16441656
]
16451657
},
16461658
"Root": {
@@ -2189,7 +2201,7 @@
21892201
},
21902202
"TcbInfoResult": {
21912203
"properties": {
2192-
"success": {
2204+
"summary": {
21932205
"$ref": "#/$defs/Result"
21942206
},
21952207
"id": {
@@ -2198,20 +2210,49 @@
21982210
"version": {
21992211
"$ref": "#/$defs/Result"
22002212
},
2213+
"tcbLevelResult": {
2214+
"$ref": "#/$defs/TcbLevelResult"
2215+
}
2216+
},
2217+
"type": "object",
2218+
"required": [
2219+
"summary",
2220+
"id",
2221+
"version",
2222+
"tcbLevelResult"
2223+
]
2224+
},
2225+
"TcbLevelResult": {
2226+
"properties": {
22012227
"status": {
22022228
"type": "string"
22032229
},
22042230
"date": {
22052231
"type": "string"
2232+
},
2233+
"pceSvn": {
2234+
"$ref": "#/$defs/Result"
2235+
},
2236+
"sgxComponents": {
2237+
"items": {
2238+
"$ref": "#/$defs/Result"
2239+
},
2240+
"type": "array"
2241+
},
2242+
"tdxComponents": {
2243+
"items": {
2244+
"$ref": "#/$defs/Result"
2245+
},
2246+
"type": "array"
22062247
}
22072248
},
22082249
"type": "object",
22092250
"required": [
2210-
"success",
2211-
"id",
2212-
"version",
22132251
"status",
2214-
"date"
2252+
"date",
2253+
"pceSvn",
2254+
"sgxComponents",
2255+
"tdxComponents"
22152256
]
22162257
},
22172258
"TdAttributesCheck": {
@@ -2562,14 +2603,8 @@
25622603
"type": {
25632604
"type": "string"
25642605
},
2565-
"success": {
2566-
"type": "boolean"
2567-
},
2568-
"errorCodes": {
2569-
"items": {
2570-
"type": "integer"
2571-
},
2572-
"type": "array"
2606+
"summary": {
2607+
"$ref": "#/$defs/Result"
25732608
},
25742609
"prover": {
25752610
"type": "string"
@@ -2589,9 +2624,6 @@
25892624
"metadata": {
25902625
"$ref": "#/$defs/MetadataSummary"
25912626
},
2592-
"policySuccess": {
2593-
"type": "boolean"
2594-
},
25952627
"reportSignatureCheck": {
25962628
"items": {
25972629
"$ref": "#/$defs/SignatureResult"
@@ -2603,7 +2635,7 @@
26032635
"required": [
26042636
"version",
26052637
"type",
2606-
"success",
2638+
"summary",
26072639
"certLevel",
26082640
"measurements",
26092641
"metadata",
@@ -2776,7 +2808,7 @@
27762808
"type": "integer"
27772809
},
27782810
"serialNumber": {
2779-
"$ref": "#/$defs/Int"
2811+
"type": "string"
27802812
},
27812813
"issuer": {
27822814
"$ref": "#/$defs/X509Name"

0 commit comments

Comments
 (0)