xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/ComponentIntegrity.v1_3_1.json (revision d125652e8a30dfeaad88bbfa5b1e04a80610469c)
1*d125652eSGunnar Mills{
2*d125652eSGunnar Mills    "$id": "http://redfish.dmtf.org/schemas/v1/ComponentIntegrity.v1_3_1.json",
3*d125652eSGunnar Mills    "$ref": "#/definitions/ComponentIntegrity",
4*d125652eSGunnar Mills    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5*d125652eSGunnar Mills    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6*d125652eSGunnar Mills    "definitions": {
7*d125652eSGunnar Mills        "Actions": {
8*d125652eSGunnar Mills            "additionalProperties": false,
9*d125652eSGunnar Mills            "description": "The available actions for this resource.",
10*d125652eSGunnar Mills            "longDescription": "This type shall contain the available actions for this resource.",
11*d125652eSGunnar Mills            "patternProperties": {
12*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
14*d125652eSGunnar Mills                    "type": [
15*d125652eSGunnar Mills                        "array",
16*d125652eSGunnar Mills                        "boolean",
17*d125652eSGunnar Mills                        "integer",
18*d125652eSGunnar Mills                        "number",
19*d125652eSGunnar Mills                        "null",
20*d125652eSGunnar Mills                        "object",
21*d125652eSGunnar Mills                        "string"
22*d125652eSGunnar Mills                    ]
23*d125652eSGunnar Mills                }
24*d125652eSGunnar Mills            },
25*d125652eSGunnar Mills            "properties": {
26*d125652eSGunnar Mills                "#ComponentIntegrity.SPDMGetSignedMeasurements": {
27*d125652eSGunnar Mills                    "$ref": "#/definitions/SPDMGetSignedMeasurements"
28*d125652eSGunnar Mills                },
29*d125652eSGunnar Mills                "#ComponentIntegrity.TPMGetSignedMeasurements": {
30*d125652eSGunnar Mills                    "$ref": "#/definitions/TPMGetSignedMeasurements"
31*d125652eSGunnar Mills                },
32*d125652eSGunnar Mills                "Oem": {
33*d125652eSGunnar Mills                    "$ref": "#/definitions/OemActions",
34*d125652eSGunnar Mills                    "description": "The available OEM-specific actions for this resource.",
35*d125652eSGunnar Mills                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
36*d125652eSGunnar Mills                }
37*d125652eSGunnar Mills            },
38*d125652eSGunnar Mills            "type": "object"
39*d125652eSGunnar Mills        },
40*d125652eSGunnar Mills        "CommonAuthInfo": {
41*d125652eSGunnar Mills            "additionalProperties": false,
42*d125652eSGunnar Mills            "description": "Common Authentication information.",
43*d125652eSGunnar Mills            "longDescription": "This object shall contain common identity-related authentication information.",
44*d125652eSGunnar Mills            "patternProperties": {
45*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
46*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
47*d125652eSGunnar Mills                    "type": [
48*d125652eSGunnar Mills                        "array",
49*d125652eSGunnar Mills                        "boolean",
50*d125652eSGunnar Mills                        "integer",
51*d125652eSGunnar Mills                        "number",
52*d125652eSGunnar Mills                        "null",
53*d125652eSGunnar Mills                        "object",
54*d125652eSGunnar Mills                        "string"
55*d125652eSGunnar Mills                    ]
56*d125652eSGunnar Mills                }
57*d125652eSGunnar Mills            },
58*d125652eSGunnar Mills            "properties": {
59*d125652eSGunnar Mills                "ComponentCertificate": {
60*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate",
61*d125652eSGunnar Mills                    "description": "A link to the certificate that represents the identity of the component.",
62*d125652eSGunnar Mills                    "longDescription": "This property shall contain a link to a resource of type `Certificate` that represents the identity of the component referenced by the `TargetComponentURI` property.",
63*d125652eSGunnar Mills                    "readonly": true
64*d125652eSGunnar Mills                },
65*d125652eSGunnar Mills                "VerificationStatus": {
66*d125652eSGunnar Mills                    "anyOf": [
67*d125652eSGunnar Mills                        {
68*d125652eSGunnar Mills                            "$ref": "#/definitions/VerificationStatus"
69*d125652eSGunnar Mills                        },
70*d125652eSGunnar Mills                        {
71*d125652eSGunnar Mills                            "type": "null"
72*d125652eSGunnar Mills                        }
73*d125652eSGunnar Mills                    ],
74*d125652eSGunnar Mills                    "description": "The status of the verification of the identity of the component.",
75*d125652eSGunnar Mills                    "longDescription": "This property shall contain the status of the verification of the identity of the component referenced by the `TargetComponentURI` property.",
76*d125652eSGunnar Mills                    "readonly": true
77*d125652eSGunnar Mills                }
78*d125652eSGunnar Mills            },
79*d125652eSGunnar Mills            "type": "object"
80*d125652eSGunnar Mills        },
81*d125652eSGunnar Mills        "CommunicationInfo": {
82*d125652eSGunnar Mills            "additionalProperties": false,
83*d125652eSGunnar Mills            "description": "Information about communication between two components.",
84*d125652eSGunnar Mills            "longDescription": "This object shall contain information about communication between two components.",
85*d125652eSGunnar Mills            "patternProperties": {
86*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
87*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
88*d125652eSGunnar Mills                    "type": [
89*d125652eSGunnar Mills                        "array",
90*d125652eSGunnar Mills                        "boolean",
91*d125652eSGunnar Mills                        "integer",
92*d125652eSGunnar Mills                        "number",
93*d125652eSGunnar Mills                        "null",
94*d125652eSGunnar Mills                        "object",
95*d125652eSGunnar Mills                        "string"
96*d125652eSGunnar Mills                    ]
97*d125652eSGunnar Mills                }
98*d125652eSGunnar Mills            },
99*d125652eSGunnar Mills            "properties": {
100*d125652eSGunnar Mills                "Sessions": {
101*d125652eSGunnar Mills                    "description": "The active sessions or communication channels between two components.",
102*d125652eSGunnar Mills                    "items": {
103*d125652eSGunnar Mills                        "anyOf": [
104*d125652eSGunnar Mills                            {
105*d125652eSGunnar Mills                                "$ref": "#/definitions/SingleSessionInfo"
106*d125652eSGunnar Mills                            },
107*d125652eSGunnar Mills                            {
108*d125652eSGunnar Mills                                "type": "null"
109*d125652eSGunnar Mills                            }
110*d125652eSGunnar Mills                        ]
111*d125652eSGunnar Mills                    },
112*d125652eSGunnar Mills                    "longDescription": "This property shall contain an array of the active sessions or communication channels between two components.  The active sessions or communication channels do not reflect how future sessions or communication channels are established.",
113*d125652eSGunnar Mills                    "type": "array"
114*d125652eSGunnar Mills                }
115*d125652eSGunnar Mills            },
116*d125652eSGunnar Mills            "type": "object"
117*d125652eSGunnar Mills        },
118*d125652eSGunnar Mills        "ComponentIntegrity": {
119*d125652eSGunnar Mills            "additionalProperties": false,
120*d125652eSGunnar Mills            "description": "The `ComponentIntegrity` resource provides critical and pertinent security information about a specific device, system, software element, or other managed entity.",
121*d125652eSGunnar Mills            "longDescription": "This resource shall represent critical and pertinent security information about a specific device, system, software element, or other managed entity.",
122*d125652eSGunnar Mills            "patternProperties": {
123*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
124*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
125*d125652eSGunnar Mills                    "type": [
126*d125652eSGunnar Mills                        "array",
127*d125652eSGunnar Mills                        "boolean",
128*d125652eSGunnar Mills                        "integer",
129*d125652eSGunnar Mills                        "number",
130*d125652eSGunnar Mills                        "null",
131*d125652eSGunnar Mills                        "object",
132*d125652eSGunnar Mills                        "string"
133*d125652eSGunnar Mills                    ]
134*d125652eSGunnar Mills                }
135*d125652eSGunnar Mills            },
136*d125652eSGunnar Mills            "properties": {
137*d125652eSGunnar Mills                "@odata.context": {
138*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
139*d125652eSGunnar Mills                },
140*d125652eSGunnar Mills                "@odata.etag": {
141*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
142*d125652eSGunnar Mills                },
143*d125652eSGunnar Mills                "@odata.id": {
144*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
145*d125652eSGunnar Mills                },
146*d125652eSGunnar Mills                "@odata.type": {
147*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
148*d125652eSGunnar Mills                },
149*d125652eSGunnar Mills                "Actions": {
150*d125652eSGunnar Mills                    "$ref": "#/definitions/Actions",
151*d125652eSGunnar Mills                    "description": "The available actions for this resource.",
152*d125652eSGunnar Mills                    "longDescription": "This property shall contain the available actions for this resource."
153*d125652eSGunnar Mills                },
154*d125652eSGunnar Mills                "ComponentIntegrityEnabled": {
155*d125652eSGunnar Mills                    "description": "An indication of whether security protocols are enabled for the component.",
156*d125652eSGunnar Mills                    "longDescription": "This property shall indicate whether security protocols are enabled for the component.  If `ComponentIntegrityType` contains `SPDM`, a value of `false` shall prohibit the SPDM Requester from using SPDM to communicate with the component identified by the `TargetComponentURI` property.  If `ComponentIntegrityType` contains `TPM`, a value of `false` shall disable the TPM component identified by the `TargetComponentURI` property entirely.  If `false`, services shall not provide the TPM and SPDM properties in response payloads for this resource.  If `false`, services shall reject action requests to this resource.  If `true`, services shall allow security protocols with the component identified by the `TargetComponentURI` property.",
157*d125652eSGunnar Mills                    "readonly": false,
158*d125652eSGunnar Mills                    "type": "boolean"
159*d125652eSGunnar Mills                },
160*d125652eSGunnar Mills                "ComponentIntegrityType": {
161*d125652eSGunnar Mills                    "$ref": "#/definitions/ComponentIntegrityType",
162*d125652eSGunnar Mills                    "description": "The type of security technology for the component.",
163*d125652eSGunnar Mills                    "longDescription": "This value of this property shall contain the underlying security technology providing integrity information for the component.",
164*d125652eSGunnar Mills                    "readonly": true
165*d125652eSGunnar Mills                },
166*d125652eSGunnar Mills                "ComponentIntegrityTypeVersion": {
167*d125652eSGunnar Mills                    "description": "The version of the security technology.",
168*d125652eSGunnar Mills                    "longDescription": "This value of this property shall contain the version of the security technology indicated by the `ComponentIntegrityType` property.  If the service has not established secure communication with the device or if security protocols are disabled, this property shall contain an empty string.  If `ComponentIntegrityType` contains `SPDM`, this property shall contain the negotiated or selected SPDM protocol and shall follow the regular expression pattern `^\\d+\\.\\d+\\.\\d+$`.  If `ComponentIntegrityType` contains `TPM`, this property shall contain the version of the TPM.",
169*d125652eSGunnar Mills                    "readonly": true,
170*d125652eSGunnar Mills                    "type": "string"
171*d125652eSGunnar Mills                },
172*d125652eSGunnar Mills                "Description": {
173*d125652eSGunnar Mills                    "anyOf": [
174*d125652eSGunnar Mills                        {
175*d125652eSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
176*d125652eSGunnar Mills                        },
177*d125652eSGunnar Mills                        {
178*d125652eSGunnar Mills                            "type": "null"
179*d125652eSGunnar Mills                        }
180*d125652eSGunnar Mills                    ],
181*d125652eSGunnar Mills                    "readonly": true
182*d125652eSGunnar Mills                },
183*d125652eSGunnar Mills                "Id": {
184*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
185*d125652eSGunnar Mills                    "readonly": true
186*d125652eSGunnar Mills                },
187*d125652eSGunnar Mills                "LastUpdated": {
188*d125652eSGunnar Mills                    "description": "The date and time when information for the component was last updated.",
189*d125652eSGunnar Mills                    "format": "date-time",
190*d125652eSGunnar Mills                    "longDescription": "This property shall contain the date and time when information for the component was last updated.",
191*d125652eSGunnar Mills                    "readonly": true,
192*d125652eSGunnar Mills                    "type": [
193*d125652eSGunnar Mills                        "string",
194*d125652eSGunnar Mills                        "null"
195*d125652eSGunnar Mills                    ]
196*d125652eSGunnar Mills                },
197*d125652eSGunnar Mills                "Links": {
198*d125652eSGunnar Mills                    "$ref": "#/definitions/Links",
199*d125652eSGunnar Mills                    "description": "The links to other resources that are related to this resource.",
200*d125652eSGunnar Mills                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
201*d125652eSGunnar Mills                },
202*d125652eSGunnar Mills                "Name": {
203*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
204*d125652eSGunnar Mills                    "readonly": true
205*d125652eSGunnar Mills                },
206*d125652eSGunnar Mills                "Oem": {
207*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
208*d125652eSGunnar Mills                    "description": "The OEM extension property.",
209*d125652eSGunnar Mills                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
210*d125652eSGunnar Mills                },
211*d125652eSGunnar Mills                "SPDM": {
212*d125652eSGunnar Mills                    "$ref": "#/definitions/SPDMinfo",
213*d125652eSGunnar Mills                    "description": "Integrity information about the SPDM Responder as reported by an SPDM Requester.",
214*d125652eSGunnar Mills                    "longDescription": "This property shall contain integrity information about the SPDM Responder identified by the `TargetComponentURI` property as reported by an SPDM Requester.  This property shall be present if `ComponentIntegrityType` contains `SPDM` and if `ComponentIntegrityEnabled` contains `true`.  For other cases, this property shall be absent."
215*d125652eSGunnar Mills                },
216*d125652eSGunnar Mills                "Status": {
217*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
218*d125652eSGunnar Mills                    "description": "The status and health of the resource and its subordinate or dependent resources.",
219*d125652eSGunnar Mills                    "longDescription": "This property shall contain any status or health properties of the resource."
220*d125652eSGunnar Mills                },
221*d125652eSGunnar Mills                "TPM": {
222*d125652eSGunnar Mills                    "$ref": "#/definitions/TPMinfo",
223*d125652eSGunnar Mills                    "description": "Integrity information about the Trusted Platform Module (TPM).",
224*d125652eSGunnar Mills                    "longDescription": "This property shall contain integrity information about the Trusted Platform Module (TPM) identified by the `TargetComponentURI` property.  This property shall be present if `ComponentIntegrityType` contains `TPM` and if `ComponentIntegrityEnabled` contains `true`.  For other cases, this property shall be absent."
225*d125652eSGunnar Mills                },
226*d125652eSGunnar Mills                "TargetComponentURI": {
227*d125652eSGunnar Mills                    "description": "The link to the component whose integrity that this resource reports.",
228*d125652eSGunnar Mills                    "format": "uri-reference",
229*d125652eSGunnar Mills                    "longDescription": "This value of this property shall contain a link to the resource whose integrity information is reported in this resource.  If `ComponentIntegrityType` contains `SPDM`, this property shall contain a URI to the resource that represents the SPDM Responder.  If `ComponentIntegrityType` contains `TPM`, this property shall contain a URI with RFC6901-defined JSON fragment notation to a member of the TrustedModules array in a ComputerSystem resource that represents the TPM or a resource of type `TrustedComponent` that represents the TPM.",
230*d125652eSGunnar Mills                    "readonly": true,
231*d125652eSGunnar Mills                    "type": "string"
232*d125652eSGunnar Mills                }
233*d125652eSGunnar Mills            },
234*d125652eSGunnar Mills            "required": [
235*d125652eSGunnar Mills                "ComponentIntegrityType",
236*d125652eSGunnar Mills                "ComponentIntegrityTypeVersion",
237*d125652eSGunnar Mills                "TargetComponentURI",
238*d125652eSGunnar Mills                "@odata.id",
239*d125652eSGunnar Mills                "@odata.type",
240*d125652eSGunnar Mills                "Id",
241*d125652eSGunnar Mills                "Name"
242*d125652eSGunnar Mills            ],
243*d125652eSGunnar Mills            "type": "object"
244*d125652eSGunnar Mills        },
245*d125652eSGunnar Mills        "ComponentIntegrityType": {
246*d125652eSGunnar Mills            "enum": [
247*d125652eSGunnar Mills                "SPDM",
248*d125652eSGunnar Mills                "TPM",
249*d125652eSGunnar Mills                "TCM",
250*d125652eSGunnar Mills                "TPCM",
251*d125652eSGunnar Mills                "OEM"
252*d125652eSGunnar Mills            ],
253*d125652eSGunnar Mills            "enumDescriptions": {
254*d125652eSGunnar Mills                "OEM": "OEM-specific.",
255*d125652eSGunnar Mills                "SPDM": "Security Protocol and Data Model (SPDM) protocol.",
256*d125652eSGunnar Mills                "TCM": "Trusted Cryptography Module (TCM).",
257*d125652eSGunnar Mills                "TPCM": "Trusted Platform Control Module (TPCM).",
258*d125652eSGunnar Mills                "TPM": "Trusted Platform Module (TPM)."
259*d125652eSGunnar Mills            },
260*d125652eSGunnar Mills            "enumLongDescriptions": {
261*d125652eSGunnar Mills                "OEM": "This value shall indicate the integrity information is OEM-specific and the OEM section may include additional information.",
262*d125652eSGunnar Mills                "SPDM": "This value shall indicate the integrity information is obtained through the Security Protocol and Data Model (SPDM) protocol as defined in DMTF DSP0274.",
263*d125652eSGunnar Mills                "TCM": "This value shall indicate the integrity information is related to a Trusted Cryptography Module (TCM) as defined by the China TCM Union (TCMU).",
264*d125652eSGunnar Mills                "TPCM": "This value shall indicate the integrity information is related to a Trusted Platform Control Module (TPCM) as defined by the Zhongguancun Trusted Computing Industry Alliance (ZTCIA).",
265*d125652eSGunnar Mills                "TPM": "This value shall indicate the integrity information is related to a Trusted Platform Module (TPM) as defined by the Trusted Computing Group (TCG)."
266*d125652eSGunnar Mills            },
267*d125652eSGunnar Mills            "enumVersionAdded": {
268*d125652eSGunnar Mills                "TCM": "v1_3_0",
269*d125652eSGunnar Mills                "TPCM": "v1_3_0"
270*d125652eSGunnar Mills            },
271*d125652eSGunnar Mills            "type": "string"
272*d125652eSGunnar Mills        },
273*d125652eSGunnar Mills        "DMTFmeasurementTypes": {
274*d125652eSGunnar Mills            "enum": [
275*d125652eSGunnar Mills                "ImmutableROM",
276*d125652eSGunnar Mills                "MutableFirmware",
277*d125652eSGunnar Mills                "HardwareConfiguration",
278*d125652eSGunnar Mills                "FirmwareConfiguration",
279*d125652eSGunnar Mills                "MutableFirmwareVersion",
280*d125652eSGunnar Mills                "MutableFirmwareSecurityVersionNumber",
281*d125652eSGunnar Mills                "MeasurementManifest"
282*d125652eSGunnar Mills            ],
283*d125652eSGunnar Mills            "enumDescriptions": {
284*d125652eSGunnar Mills                "FirmwareConfiguration": "Firmware configuration, such as configurable firmware policy.",
285*d125652eSGunnar Mills                "HardwareConfiguration": "Hardware configuration, such as straps.",
286*d125652eSGunnar Mills                "ImmutableROM": "Immutable ROM.",
287*d125652eSGunnar Mills                "MeasurementManifest": "Measurement Manifest.",
288*d125652eSGunnar Mills                "MutableFirmware": "Mutable firmware or any mutable code.",
289*d125652eSGunnar Mills                "MutableFirmwareSecurityVersionNumber": "Mutable firmware security version number.",
290*d125652eSGunnar Mills                "MutableFirmwareVersion": "Mutable firmware version."
291*d125652eSGunnar Mills            },
292*d125652eSGunnar Mills            "type": "string"
293*d125652eSGunnar Mills        },
294*d125652eSGunnar Mills        "Links": {
295*d125652eSGunnar Mills            "additionalProperties": false,
296*d125652eSGunnar Mills            "description": "The links to other resources that are related to this resource.",
297*d125652eSGunnar Mills            "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
298*d125652eSGunnar Mills            "patternProperties": {
299*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
300*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
301*d125652eSGunnar Mills                    "type": [
302*d125652eSGunnar Mills                        "array",
303*d125652eSGunnar Mills                        "boolean",
304*d125652eSGunnar Mills                        "integer",
305*d125652eSGunnar Mills                        "number",
306*d125652eSGunnar Mills                        "null",
307*d125652eSGunnar Mills                        "object",
308*d125652eSGunnar Mills                        "string"
309*d125652eSGunnar Mills                    ]
310*d125652eSGunnar Mills                }
311*d125652eSGunnar Mills            },
312*d125652eSGunnar Mills            "properties": {
313*d125652eSGunnar Mills                "ComponentsProtected": {
314*d125652eSGunnar Mills                    "description": "An array of links to resources that the target component protects.",
315*d125652eSGunnar Mills                    "items": {
316*d125652eSGunnar Mills                        "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
317*d125652eSGunnar Mills                    },
318*d125652eSGunnar Mills                    "longDescription": "This property shall contain an array of links to resources that the component identified by the `TargetComponentURI` property provides integrity protection.  This property shall not contain the value of the `TargetComponentURI` property.",
319*d125652eSGunnar Mills                    "readonly": true,
320*d125652eSGunnar Mills                    "type": "array"
321*d125652eSGunnar Mills                },
322*d125652eSGunnar Mills                "ComponentsProtected@odata.count": {
323*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
324*d125652eSGunnar Mills                },
325*d125652eSGunnar Mills                "Oem": {
326*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
327*d125652eSGunnar Mills                    "description": "The OEM extension property.",
328*d125652eSGunnar Mills                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
329*d125652eSGunnar Mills                }
330*d125652eSGunnar Mills            },
331*d125652eSGunnar Mills            "type": "object"
332*d125652eSGunnar Mills        },
333*d125652eSGunnar Mills        "MeasurementSpecification": {
334*d125652eSGunnar Mills            "enum": [
335*d125652eSGunnar Mills                "DMTF"
336*d125652eSGunnar Mills            ],
337*d125652eSGunnar Mills            "enumDescriptions": {
338*d125652eSGunnar Mills                "DMTF": "DMTF."
339*d125652eSGunnar Mills            },
340*d125652eSGunnar Mills            "enumLongDescriptions": {
341*d125652eSGunnar Mills                "DMTF": "This value shall indicate the measurement specification is defined by DMTF in DSP0274."
342*d125652eSGunnar Mills            },
343*d125652eSGunnar Mills            "type": "string"
344*d125652eSGunnar Mills        },
345*d125652eSGunnar Mills        "OemActions": {
346*d125652eSGunnar Mills            "additionalProperties": true,
347*d125652eSGunnar Mills            "description": "The available OEM-specific actions for this resource.",
348*d125652eSGunnar Mills            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
349*d125652eSGunnar Mills            "patternProperties": {
350*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
351*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
352*d125652eSGunnar Mills                    "type": [
353*d125652eSGunnar Mills                        "array",
354*d125652eSGunnar Mills                        "boolean",
355*d125652eSGunnar Mills                        "integer",
356*d125652eSGunnar Mills                        "number",
357*d125652eSGunnar Mills                        "null",
358*d125652eSGunnar Mills                        "object",
359*d125652eSGunnar Mills                        "string"
360*d125652eSGunnar Mills                    ]
361*d125652eSGunnar Mills                }
362*d125652eSGunnar Mills            },
363*d125652eSGunnar Mills            "properties": {},
364*d125652eSGunnar Mills            "type": "object"
365*d125652eSGunnar Mills        },
366*d125652eSGunnar Mills        "SPDMGetSignedMeasurements": {
367*d125652eSGunnar Mills            "actionResponse": {
368*d125652eSGunnar Mills                "$ref": "#/definitions/SPDMGetSignedMeasurementsResponse"
369*d125652eSGunnar Mills            },
370*d125652eSGunnar Mills            "additionalProperties": false,
371*d125652eSGunnar Mills            "description": "This action generates an SPDM cryptographic signed statement over the given nonce and measurements of the SPDM Responder.",
372*d125652eSGunnar Mills            "longDescription": "This action shall generate a cryptographic signed statement over the given nonce and measurements corresponding to the SPDM Responder.  This action shall not be present if the `ComponentIntegrityType` property does not contain the value `SPDM`.  The SPDM Requester shall issue one or more SPDM 'GET_MEASUREMENTS' requests for each of the requested measurement indices to the SPDM Responder.  When the SPDM 'GET_MEASUREMENTS' requests are made for version 1.2, the parameter 'RawBitStreamRequested' shall contain `0`.  The SPDM Requester shall provide the nonce for the action to the SPDM Responder in the last SPDM 'GET_MEASUREMENTS' request.  The SPDM Requester shall request a signature in the last SPDM 'GET_MEASUREMENTS' request.",
373*d125652eSGunnar Mills            "parameters": {
374*d125652eSGunnar Mills                "MeasurementIndices": {
375*d125652eSGunnar Mills                    "description": "An array of indices that identify the measurement blocks to sign.",
376*d125652eSGunnar Mills                    "items": {
377*d125652eSGunnar Mills                        "type": "integer"
378*d125652eSGunnar Mills                    },
379*d125652eSGunnar Mills                    "longDescription": "This parameter shall contain an array of indices that identify the measurement blocks to sign.  This array shall contain one or more unique values between `0` to `254`, inclusive, or contain a single value of `255`.  If not provided by the client, the value shall be assumed to be an array containing a single value of `255`.",
380*d125652eSGunnar Mills                    "type": "array"
381*d125652eSGunnar Mills                },
382*d125652eSGunnar Mills                "Nonce": {
383*d125652eSGunnar Mills                    "description": "A 32-byte hex-encoded string that is signed with the measurements.  The value should be unique.",
384*d125652eSGunnar Mills                    "longDescription": "This parameter shall contain a 32-byte hex-encoded string that is signed with the measurements.  If not provided by the client, the SPDM Requester shall generate the nonce.  The value should be unique and generated using a random or a pseudo-random generator.  The SPDM Requester shall send this value to the SPDM Responder in the SPDM 'GET_MEASUREMENTS' request.",
385*d125652eSGunnar Mills                    "pattern": "^[0-9a-fA-F]{64}$",
386*d125652eSGunnar Mills                    "type": "string"
387*d125652eSGunnar Mills                },
388*d125652eSGunnar Mills                "SlotId": {
389*d125652eSGunnar Mills                    "description": "The slot identifier for the certificate containing the private key to generate the signature over the measurements.",
390*d125652eSGunnar Mills                    "longDescription": "This parameter shall contain the SPDM slot identifier for the certificate containing the private key to generate the signature over the measurements.  If not provided by the client, the value shall be assumed to be `0`.  The SPDM Requester shall send this value to the SPDM Responder in the SPDM 'GET_MEASUREMENTS' request.",
391*d125652eSGunnar Mills                    "type": "integer"
392*d125652eSGunnar Mills                }
393*d125652eSGunnar Mills            },
394*d125652eSGunnar Mills            "patternProperties": {
395*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
396*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
397*d125652eSGunnar Mills                    "type": [
398*d125652eSGunnar Mills                        "array",
399*d125652eSGunnar Mills                        "boolean",
400*d125652eSGunnar Mills                        "integer",
401*d125652eSGunnar Mills                        "number",
402*d125652eSGunnar Mills                        "null",
403*d125652eSGunnar Mills                        "object",
404*d125652eSGunnar Mills                        "string"
405*d125652eSGunnar Mills                    ]
406*d125652eSGunnar Mills                }
407*d125652eSGunnar Mills            },
408*d125652eSGunnar Mills            "properties": {
409*d125652eSGunnar Mills                "target": {
410*d125652eSGunnar Mills                    "description": "Link to invoke action",
411*d125652eSGunnar Mills                    "format": "uri-reference",
412*d125652eSGunnar Mills                    "type": "string"
413*d125652eSGunnar Mills                },
414*d125652eSGunnar Mills                "title": {
415*d125652eSGunnar Mills                    "description": "Friendly action name",
416*d125652eSGunnar Mills                    "type": "string"
417*d125652eSGunnar Mills                }
418*d125652eSGunnar Mills            },
419*d125652eSGunnar Mills            "type": "object"
420*d125652eSGunnar Mills        },
421*d125652eSGunnar Mills        "SPDMGetSignedMeasurementsResponse": {
422*d125652eSGunnar Mills            "additionalProperties": false,
423*d125652eSGunnar Mills            "description": "The SPDM signed measurement from an SPDM Responder.",
424*d125652eSGunnar Mills            "longDescription": "This object shall contain the SPDM signed measurements from an SPDM Responder.",
425*d125652eSGunnar Mills            "patternProperties": {
426*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
427*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
428*d125652eSGunnar Mills                    "type": [
429*d125652eSGunnar Mills                        "array",
430*d125652eSGunnar Mills                        "boolean",
431*d125652eSGunnar Mills                        "integer",
432*d125652eSGunnar Mills                        "number",
433*d125652eSGunnar Mills                        "null",
434*d125652eSGunnar Mills                        "object",
435*d125652eSGunnar Mills                        "string"
436*d125652eSGunnar Mills                    ]
437*d125652eSGunnar Mills                }
438*d125652eSGunnar Mills            },
439*d125652eSGunnar Mills            "properties": {
440*d125652eSGunnar Mills                "Certificate": {
441*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate",
442*d125652eSGunnar Mills                    "description": "A link to the certificate corresponding to the SPDM slot identifier that can be used to validate the signature.",
443*d125652eSGunnar Mills                    "longDescription": "This property shall contain a link to a resource of type `Certificate` that represents the certificate corresponding to the SPDM slot identifier that can be used to validate the signature.  This property shall not be present if the SlotId parameter contains the value `15`.",
444*d125652eSGunnar Mills                    "readonly": true
445*d125652eSGunnar Mills                },
446*d125652eSGunnar Mills                "HashingAlgorithm": {
447*d125652eSGunnar Mills                    "description": "The hashing algorithm used for generating the cryptographic signed statement.",
448*d125652eSGunnar Mills                    "longDescription": "This property shall contain the hashing algorithm negotiated between the SPDM Requester and the SPDM Responder.  The allowable values for this property shall be the hash algorithm names found in the 'BaseHashAlgo' field of the 'NEGOTIATE_ALGORITHMS' request message in DSP0274.  If the algorithm is an extended algorithm, this property shall contain the value `OEM`.",
449*d125652eSGunnar Mills                    "readonly": true,
450*d125652eSGunnar Mills                    "type": "string"
451*d125652eSGunnar Mills                },
452*d125652eSGunnar Mills                "Oem": {
453*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
454*d125652eSGunnar Mills                    "description": "The OEM extension property.",
455*d125652eSGunnar Mills                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
456*d125652eSGunnar Mills                },
457*d125652eSGunnar Mills                "PublicKey": {
458*d125652eSGunnar Mills                    "description": "A Privacy Enhanced Mail (PEM)-encoded public key that can be used to validate the signature.",
459*d125652eSGunnar Mills                    "longDescription": "This property shall contain a Privacy Enhanced Mail (PEM)-encoded public key, as defined in section 13 of RFC7468, that can be used to validate the signature.  This property shall only be present when the SPDM Requester was pre-provisioned with the SPDM Responder's public key and the SlotId parameter contains the value `15`.",
460*d125652eSGunnar Mills                    "readonly": true,
461*d125652eSGunnar Mills                    "type": "string"
462*d125652eSGunnar Mills                },
463*d125652eSGunnar Mills                "SignedMeasurements": {
464*d125652eSGunnar Mills                    "description": "Base64-encoded cryptographic signed statement generated by the signer.",
465*d125652eSGunnar Mills                    "longDescription": "This property shall contain the cryptographic signed statement over the given nonce and measurement blocks corresponding to the requested measurement indices.  If the SPDM version is 1.2, this value shall be a concatenation of SPDM 'VCA' and 'GET_MEASUREMENTS' requests and responses exchanged between the SPDM Requester and the SPDM Responder.  If SPDM version is 1.0 or 1.1, this value shall be a concatenation of SPDM 'GET_MEASUREMENTS' requests and responses exchanged between the SPDM Requester and the SPDM Responder.  The last 'MEASUREMENTS' response shall contain a signature generated over the 'L2' string by the SPDM Responder.",
466*d125652eSGunnar Mills                    "readonly": true,
467*d125652eSGunnar Mills                    "type": "string"
468*d125652eSGunnar Mills                },
469*d125652eSGunnar Mills                "SigningAlgorithm": {
470*d125652eSGunnar Mills                    "description": "The asymmetric signing algorithm used for generating the cryptographic signed statement.",
471*d125652eSGunnar Mills                    "longDescription": "This property shall contain the asymmetric signing algorithm negotiated between the SPDM Requester and the SPDM Responder.  The allowable values for this property shall be the asymmetric key signature algorithm names found in the 'BaseAsymAlgo' field of the 'NEGOTIATE_ALGORITHMS' request message in DSP0274.  If the algorithm is an extended algorithm, this property shall contain the value `OEM`.",
472*d125652eSGunnar Mills                    "readonly": true,
473*d125652eSGunnar Mills                    "type": "string"
474*d125652eSGunnar Mills                },
475*d125652eSGunnar Mills                "Version": {
476*d125652eSGunnar Mills                    "description": "The SPDM version used by the SPDM Responder to generate the cryptographic signed statement.",
477*d125652eSGunnar Mills                    "longDescription": "This property shall contain the SPDM version negotiated between the SPDM Requester and the SPDM Responder to generate the cryptographic signed statement.  For example, `1.0`, `1.1`, or `1.2`.",
478*d125652eSGunnar Mills                    "readonly": true,
479*d125652eSGunnar Mills                    "type": "string"
480*d125652eSGunnar Mills                }
481*d125652eSGunnar Mills            },
482*d125652eSGunnar Mills            "required": [
483*d125652eSGunnar Mills                "SignedMeasurements",
484*d125652eSGunnar Mills                "Version",
485*d125652eSGunnar Mills                "HashingAlgorithm",
486*d125652eSGunnar Mills                "SigningAlgorithm"
487*d125652eSGunnar Mills            ],
488*d125652eSGunnar Mills            "type": "object"
489*d125652eSGunnar Mills        },
490*d125652eSGunnar Mills        "SPDMcommunication": {
491*d125652eSGunnar Mills            "additionalProperties": false,
492*d125652eSGunnar Mills            "description": "Information about communication between two components.",
493*d125652eSGunnar Mills            "longDescription": "This object shall contain information about communication between two components.",
494*d125652eSGunnar Mills            "patternProperties": {
495*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
496*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
497*d125652eSGunnar Mills                    "type": [
498*d125652eSGunnar Mills                        "array",
499*d125652eSGunnar Mills                        "boolean",
500*d125652eSGunnar Mills                        "integer",
501*d125652eSGunnar Mills                        "number",
502*d125652eSGunnar Mills                        "null",
503*d125652eSGunnar Mills                        "object",
504*d125652eSGunnar Mills                        "string"
505*d125652eSGunnar Mills                    ]
506*d125652eSGunnar Mills                }
507*d125652eSGunnar Mills            },
508*d125652eSGunnar Mills            "properties": {
509*d125652eSGunnar Mills                "Sessions": {
510*d125652eSGunnar Mills                    "description": "The active sessions or communication channels between two components.",
511*d125652eSGunnar Mills                    "items": {
512*d125652eSGunnar Mills                        "anyOf": [
513*d125652eSGunnar Mills                            {
514*d125652eSGunnar Mills                                "$ref": "#/definitions/SingleSessionInfo"
515*d125652eSGunnar Mills                            },
516*d125652eSGunnar Mills                            {
517*d125652eSGunnar Mills                                "type": "null"
518*d125652eSGunnar Mills                            }
519*d125652eSGunnar Mills                        ]
520*d125652eSGunnar Mills                    },
521*d125652eSGunnar Mills                    "longDescription": "This property shall contain an array of the active sessions or communication channels between two components.  The active sessions or communication channels do not reflect how future sessions or communication channels are established.",
522*d125652eSGunnar Mills                    "type": "array"
523*d125652eSGunnar Mills                }
524*d125652eSGunnar Mills            },
525*d125652eSGunnar Mills            "type": "object"
526*d125652eSGunnar Mills        },
527*d125652eSGunnar Mills        "SPDMidentity": {
528*d125652eSGunnar Mills            "additionalProperties": false,
529*d125652eSGunnar Mills            "description": "Identity authentication information about the SPDM Requester and SPDM Responder.",
530*d125652eSGunnar Mills            "longDescription": "This object shall contain identity authentication information about the SPDM Requester and SPDM Responder.",
531*d125652eSGunnar Mills            "patternProperties": {
532*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
533*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
534*d125652eSGunnar Mills                    "type": [
535*d125652eSGunnar Mills                        "array",
536*d125652eSGunnar Mills                        "boolean",
537*d125652eSGunnar Mills                        "integer",
538*d125652eSGunnar Mills                        "number",
539*d125652eSGunnar Mills                        "null",
540*d125652eSGunnar Mills                        "object",
541*d125652eSGunnar Mills                        "string"
542*d125652eSGunnar Mills                    ]
543*d125652eSGunnar Mills                }
544*d125652eSGunnar Mills            },
545*d125652eSGunnar Mills            "properties": {
546*d125652eSGunnar Mills                "RequesterAuthentication": {
547*d125652eSGunnar Mills                    "anyOf": [
548*d125652eSGunnar Mills                        {
549*d125652eSGunnar Mills                            "$ref": "#/definitions/SPDMrequesterAuth"
550*d125652eSGunnar Mills                        },
551*d125652eSGunnar Mills                        {
552*d125652eSGunnar Mills                            "type": "null"
553*d125652eSGunnar Mills                        }
554*d125652eSGunnar Mills                    ],
555*d125652eSGunnar Mills                    "description": "Authentication information of the identity of the SPDM Requester.",
556*d125652eSGunnar Mills                    "longDescription": "This property shall contain authentication information of the identity of the SPDM Requester."
557*d125652eSGunnar Mills                },
558*d125652eSGunnar Mills                "ResponderAuthentication": {
559*d125652eSGunnar Mills                    "anyOf": [
560*d125652eSGunnar Mills                        {
561*d125652eSGunnar Mills                            "$ref": "#/definitions/SPDMresponderAuth"
562*d125652eSGunnar Mills                        },
563*d125652eSGunnar Mills                        {
564*d125652eSGunnar Mills                            "type": "null"
565*d125652eSGunnar Mills                        }
566*d125652eSGunnar Mills                    ],
567*d125652eSGunnar Mills                    "description": "Authentication information of the identity of the SPDM Responder.",
568*d125652eSGunnar Mills                    "longDescription": "This property shall contain authentication information of the identity of the SPDM Responder."
569*d125652eSGunnar Mills                }
570*d125652eSGunnar Mills            },
571*d125652eSGunnar Mills            "type": "object"
572*d125652eSGunnar Mills        },
573*d125652eSGunnar Mills        "SPDMinfo": {
574*d125652eSGunnar Mills            "additionalProperties": false,
575*d125652eSGunnar Mills            "description": "Integrity information about an SPDM Responder as reported by an SPDM Requester.",
576*d125652eSGunnar Mills            "longDescription": "This object shall contain integrity information about an SPDM Responder as reported by an SPDM Requester.",
577*d125652eSGunnar Mills            "patternProperties": {
578*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
579*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
580*d125652eSGunnar Mills                    "type": [
581*d125652eSGunnar Mills                        "array",
582*d125652eSGunnar Mills                        "boolean",
583*d125652eSGunnar Mills                        "integer",
584*d125652eSGunnar Mills                        "number",
585*d125652eSGunnar Mills                        "null",
586*d125652eSGunnar Mills                        "object",
587*d125652eSGunnar Mills                        "string"
588*d125652eSGunnar Mills                    ]
589*d125652eSGunnar Mills                }
590*d125652eSGunnar Mills            },
591*d125652eSGunnar Mills            "properties": {
592*d125652eSGunnar Mills                "ComponentCommunication": {
593*d125652eSGunnar Mills                    "anyOf": [
594*d125652eSGunnar Mills                        {
595*d125652eSGunnar Mills                            "$ref": "#/definitions/SPDMcommunication"
596*d125652eSGunnar Mills                        },
597*d125652eSGunnar Mills                        {
598*d125652eSGunnar Mills                            "type": "null"
599*d125652eSGunnar Mills                        }
600*d125652eSGunnar Mills                    ],
601*d125652eSGunnar Mills                    "description": "Information about communication between the SPDM Requester and SPDM Responder.",
602*d125652eSGunnar Mills                    "longDescription": "This property shall contain information about communication between the SPDM Requester and SPDM Responder."
603*d125652eSGunnar Mills                },
604*d125652eSGunnar Mills                "IdentityAuthentication": {
605*d125652eSGunnar Mills                    "anyOf": [
606*d125652eSGunnar Mills                        {
607*d125652eSGunnar Mills                            "$ref": "#/definitions/SPDMidentity"
608*d125652eSGunnar Mills                        },
609*d125652eSGunnar Mills                        {
610*d125652eSGunnar Mills                            "type": "null"
611*d125652eSGunnar Mills                        }
612*d125652eSGunnar Mills                    ],
613*d125652eSGunnar Mills                    "description": "Identity authentication information about the SPDM Requester and SPDM Responder.",
614*d125652eSGunnar Mills                    "longDescription": "This property shall contain identity authentication information about the SPDM Requester and SPDM Responder."
615*d125652eSGunnar Mills                },
616*d125652eSGunnar Mills                "MeasurementSet": {
617*d125652eSGunnar Mills                    "anyOf": [
618*d125652eSGunnar Mills                        {
619*d125652eSGunnar Mills                            "$ref": "#/definitions/SPDMmeasurementSet"
620*d125652eSGunnar Mills                        },
621*d125652eSGunnar Mills                        {
622*d125652eSGunnar Mills                            "type": "null"
623*d125652eSGunnar Mills                        }
624*d125652eSGunnar Mills                    ],
625*d125652eSGunnar Mills                    "description": "Measurement information about the SPDM Responder.",
626*d125652eSGunnar Mills                    "longDescription": "This property shall contain measurement information for the SPDM Responder."
627*d125652eSGunnar Mills                },
628*d125652eSGunnar Mills                "Requester": {
629*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef",
630*d125652eSGunnar Mills                    "description": "The link to the component that is reporting the integrity information of the target component.",
631*d125652eSGunnar Mills                    "longDescription": "This property shall contain a link to the resource representing the SPDM Responder that is reporting the integrity of the SPDM Responder identified by the `TargetComponentURI` property.",
632*d125652eSGunnar Mills                    "readonly": true
633*d125652eSGunnar Mills                }
634*d125652eSGunnar Mills            },
635*d125652eSGunnar Mills            "required": [
636*d125652eSGunnar Mills                "Requester"
637*d125652eSGunnar Mills            ],
638*d125652eSGunnar Mills            "type": "object"
639*d125652eSGunnar Mills        },
640*d125652eSGunnar Mills        "SPDMmeasurementSet": {
641*d125652eSGunnar Mills            "additionalProperties": false,
642*d125652eSGunnar Mills            "description": "SPDM Responder measurement information.",
643*d125652eSGunnar Mills            "longDescription": "This object shall contain SPDM Responder measurement information.",
644*d125652eSGunnar Mills            "patternProperties": {
645*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
646*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
647*d125652eSGunnar Mills                    "type": [
648*d125652eSGunnar Mills                        "array",
649*d125652eSGunnar Mills                        "boolean",
650*d125652eSGunnar Mills                        "integer",
651*d125652eSGunnar Mills                        "number",
652*d125652eSGunnar Mills                        "null",
653*d125652eSGunnar Mills                        "object",
654*d125652eSGunnar Mills                        "string"
655*d125652eSGunnar Mills                    ]
656*d125652eSGunnar Mills                }
657*d125652eSGunnar Mills            },
658*d125652eSGunnar Mills            "properties": {
659*d125652eSGunnar Mills                "MeasurementSpecification": {
660*d125652eSGunnar Mills                    "anyOf": [
661*d125652eSGunnar Mills                        {
662*d125652eSGunnar Mills                            "$ref": "#/definitions/MeasurementSpecification"
663*d125652eSGunnar Mills                        },
664*d125652eSGunnar Mills                        {
665*d125652eSGunnar Mills                            "type": "null"
666*d125652eSGunnar Mills                        }
667*d125652eSGunnar Mills                    ],
668*d125652eSGunnar Mills                    "description": "The measurement specification negotiated between the SPDM Requester and SPDM Responder.",
669*d125652eSGunnar Mills                    "longDescription": "This property shall contain the measurement specification negotiated between the SPDM Requester and SPDM Responder.",
670*d125652eSGunnar Mills                    "readonly": true
671*d125652eSGunnar Mills                },
672*d125652eSGunnar Mills                "MeasurementSummary": {
673*d125652eSGunnar Mills                    "description": "The measurement summary data.",
674*d125652eSGunnar Mills                    "longDescription": "This property shall contain a Base64-encoded string, with padding characters, of the measurement summary using the hash algorithm indicated by the `MeasurementSummaryHashAlgorithm` property.",
675*d125652eSGunnar Mills                    "pattern": "^[A-Za-z0-9+/]+={0,2}$",
676*d125652eSGunnar Mills                    "readonly": true,
677*d125652eSGunnar Mills                    "type": [
678*d125652eSGunnar Mills                        "string",
679*d125652eSGunnar Mills                        "null"
680*d125652eSGunnar Mills                    ]
681*d125652eSGunnar Mills                },
682*d125652eSGunnar Mills                "MeasurementSummaryHashAlgorithm": {
683*d125652eSGunnar Mills                    "description": "The hash algorithm used to compute the measurement summary.",
684*d125652eSGunnar Mills                    "longDescription": "This property shall contain the hash algorithm used to compute the measurement summary.  The allowable values for this property shall be the hash algorithm names found in the 'BaseHashAlgo' field of the 'NEGOTIATE_ALGORITHMS' request message in DSP0274.  If the algorithm is an extended algorithm, this property shall contain the value `OEM`.",
685*d125652eSGunnar Mills                    "readonly": true,
686*d125652eSGunnar Mills                    "type": [
687*d125652eSGunnar Mills                        "string",
688*d125652eSGunnar Mills                        "null"
689*d125652eSGunnar Mills                    ]
690*d125652eSGunnar Mills                },
691*d125652eSGunnar Mills                "MeasurementSummaryType": {
692*d125652eSGunnar Mills                    "anyOf": [
693*d125652eSGunnar Mills                        {
694*d125652eSGunnar Mills                            "$ref": "#/definitions/SPDMmeasurementSummaryType"
695*d125652eSGunnar Mills                        },
696*d125652eSGunnar Mills                        {
697*d125652eSGunnar Mills                            "type": "null"
698*d125652eSGunnar Mills                        }
699*d125652eSGunnar Mills                    ],
700*d125652eSGunnar Mills                    "description": "The type of measurement summary.",
701*d125652eSGunnar Mills                    "longDescription": "This property shall contain the type of measurement summary.",
702*d125652eSGunnar Mills                    "readonly": true
703*d125652eSGunnar Mills                },
704*d125652eSGunnar Mills                "Measurements": {
705*d125652eSGunnar Mills                    "description": "Measurements from an SPDM Responder.",
706*d125652eSGunnar Mills                    "items": {
707*d125652eSGunnar Mills                        "anyOf": [
708*d125652eSGunnar Mills                            {
709*d125652eSGunnar Mills                                "$ref": "#/definitions/SPDMsingleMeasurement"
710*d125652eSGunnar Mills                            },
711*d125652eSGunnar Mills                            {
712*d125652eSGunnar Mills                                "type": "null"
713*d125652eSGunnar Mills                            }
714*d125652eSGunnar Mills                        ]
715*d125652eSGunnar Mills                    },
716*d125652eSGunnar Mills                    "longDescription": "This property shall contain measurements from an SPDM Responder.",
717*d125652eSGunnar Mills                    "type": "array"
718*d125652eSGunnar Mills                },
719*d125652eSGunnar Mills                "Oem": {
720*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
721*d125652eSGunnar Mills                    "description": "The OEM extension property.",
722*d125652eSGunnar Mills                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
723*d125652eSGunnar Mills                }
724*d125652eSGunnar Mills            },
725*d125652eSGunnar Mills            "type": "object"
726*d125652eSGunnar Mills        },
727*d125652eSGunnar Mills        "SPDMmeasurementSummaryType": {
728*d125652eSGunnar Mills            "enum": [
729*d125652eSGunnar Mills                "TCB",
730*d125652eSGunnar Mills                "All"
731*d125652eSGunnar Mills            ],
732*d125652eSGunnar Mills            "enumDescriptions": {
733*d125652eSGunnar Mills                "All": "The measurement summary covers all measurements in SPDM.",
734*d125652eSGunnar Mills                "TCB": "The measurement summary covers the TCB."
735*d125652eSGunnar Mills            },
736*d125652eSGunnar Mills            "type": "string"
737*d125652eSGunnar Mills        },
738*d125652eSGunnar Mills        "SPDMrequesterAuth": {
739*d125652eSGunnar Mills            "additionalProperties": false,
740*d125652eSGunnar Mills            "description": "Authentication information of the identity of the SPDM Requester.",
741*d125652eSGunnar Mills            "longDescription": "This object shall contain authentication information of the identity of the SPDM Requester.",
742*d125652eSGunnar Mills            "patternProperties": {
743*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
744*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
745*d125652eSGunnar Mills                    "type": [
746*d125652eSGunnar Mills                        "array",
747*d125652eSGunnar Mills                        "boolean",
748*d125652eSGunnar Mills                        "integer",
749*d125652eSGunnar Mills                        "number",
750*d125652eSGunnar Mills                        "null",
751*d125652eSGunnar Mills                        "object",
752*d125652eSGunnar Mills                        "string"
753*d125652eSGunnar Mills                    ]
754*d125652eSGunnar Mills                }
755*d125652eSGunnar Mills            },
756*d125652eSGunnar Mills            "properties": {
757*d125652eSGunnar Mills                "ProvidedCertificate": {
758*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate",
759*d125652eSGunnar Mills                    "description": "A link to the certificate that represents the identity of the SPDM Requester provided in mutual authentication.",
760*d125652eSGunnar Mills                    "longDescription": "This property shall contain a link to a resource of type `Certificate` that represents the identity of the SPDM Requester provided in mutual authentication.",
761*d125652eSGunnar Mills                    "readonly": true
762*d125652eSGunnar Mills                }
763*d125652eSGunnar Mills            },
764*d125652eSGunnar Mills            "type": "object"
765*d125652eSGunnar Mills        },
766*d125652eSGunnar Mills        "SPDMresponderAuth": {
767*d125652eSGunnar Mills            "additionalProperties": false,
768*d125652eSGunnar Mills            "description": "Common Authentication information.",
769*d125652eSGunnar Mills            "longDescription": "This object shall contain common identity-related authentication information.",
770*d125652eSGunnar Mills            "patternProperties": {
771*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
772*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
773*d125652eSGunnar Mills                    "type": [
774*d125652eSGunnar Mills                        "array",
775*d125652eSGunnar Mills                        "boolean",
776*d125652eSGunnar Mills                        "integer",
777*d125652eSGunnar Mills                        "number",
778*d125652eSGunnar Mills                        "null",
779*d125652eSGunnar Mills                        "object",
780*d125652eSGunnar Mills                        "string"
781*d125652eSGunnar Mills                    ]
782*d125652eSGunnar Mills                }
783*d125652eSGunnar Mills            },
784*d125652eSGunnar Mills            "properties": {
785*d125652eSGunnar Mills                "ComponentCertificate": {
786*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate",
787*d125652eSGunnar Mills                    "description": "A link to the certificate that represents the identity of the component.",
788*d125652eSGunnar Mills                    "longDescription": "This property shall contain a link to a resource of type `Certificate` that represents the identity of the component referenced by the `TargetComponentURI` property.",
789*d125652eSGunnar Mills                    "readonly": true
790*d125652eSGunnar Mills                },
791*d125652eSGunnar Mills                "VerificationStatus": {
792*d125652eSGunnar Mills                    "anyOf": [
793*d125652eSGunnar Mills                        {
794*d125652eSGunnar Mills                            "$ref": "#/definitions/VerificationStatus"
795*d125652eSGunnar Mills                        },
796*d125652eSGunnar Mills                        {
797*d125652eSGunnar Mills                            "type": "null"
798*d125652eSGunnar Mills                        }
799*d125652eSGunnar Mills                    ],
800*d125652eSGunnar Mills                    "description": "The status of the verification of the identity of the component.",
801*d125652eSGunnar Mills                    "longDescription": "This property shall contain the status of the verification of the identity of the component referenced by the `TargetComponentURI` property.",
802*d125652eSGunnar Mills                    "readonly": true
803*d125652eSGunnar Mills                }
804*d125652eSGunnar Mills            },
805*d125652eSGunnar Mills            "type": "object"
806*d125652eSGunnar Mills        },
807*d125652eSGunnar Mills        "SPDMsingleMeasurement": {
808*d125652eSGunnar Mills            "additionalProperties": false,
809*d125652eSGunnar Mills            "description": "A single SPDM measurement for an SPDM Responder.",
810*d125652eSGunnar Mills            "longDescription": "This object shall contain a single SPDM measurement for an SPDM Responder.",
811*d125652eSGunnar Mills            "patternProperties": {
812*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
813*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
814*d125652eSGunnar Mills                    "type": [
815*d125652eSGunnar Mills                        "array",
816*d125652eSGunnar Mills                        "boolean",
817*d125652eSGunnar Mills                        "integer",
818*d125652eSGunnar Mills                        "number",
819*d125652eSGunnar Mills                        "null",
820*d125652eSGunnar Mills                        "object",
821*d125652eSGunnar Mills                        "string"
822*d125652eSGunnar Mills                    ]
823*d125652eSGunnar Mills                }
824*d125652eSGunnar Mills            },
825*d125652eSGunnar Mills            "properties": {
826*d125652eSGunnar Mills                "LastUpdated": {
827*d125652eSGunnar Mills                    "description": "The date and time when information for the measurement was last updated.",
828*d125652eSGunnar Mills                    "format": "date-time",
829*d125652eSGunnar Mills                    "longDescription": "This property shall contain the date and time when information for the measurement was last updated.",
830*d125652eSGunnar Mills                    "readonly": true,
831*d125652eSGunnar Mills                    "type": [
832*d125652eSGunnar Mills                        "string",
833*d125652eSGunnar Mills                        "null"
834*d125652eSGunnar Mills                    ]
835*d125652eSGunnar Mills                },
836*d125652eSGunnar Mills                "Measurement": {
837*d125652eSGunnar Mills                    "description": "The measurement data.",
838*d125652eSGunnar Mills                    "longDescription": "This property shall contain a Base64-encoded string, with padding characters, of the measurement using the hash algorithm indicated by the `MeasurementHashAlgorithm` property.  This property shall not contain a raw bit stream as a measurement.  If the SPDM Responder provides a raw bit stream, the SPDM Requester may apply a hash algorithm to the raw bit stream in order to report the measurement.",
839*d125652eSGunnar Mills                    "pattern": "^[A-Za-z0-9+/]+={0,2}$",
840*d125652eSGunnar Mills                    "readonly": true,
841*d125652eSGunnar Mills                    "type": [
842*d125652eSGunnar Mills                        "string",
843*d125652eSGunnar Mills                        "null"
844*d125652eSGunnar Mills                    ]
845*d125652eSGunnar Mills                },
846*d125652eSGunnar Mills                "MeasurementHashAlgorithm": {
847*d125652eSGunnar Mills                    "description": "The hash algorithm used to compute the measurement.",
848*d125652eSGunnar Mills                    "longDescription": "This property shall contain the hash algorithm used to compute the measurement.  The allowable values for this property shall be the hash algorithm names found in the 'BaseHashAlgo' field of the 'NEGOTIATE_ALGORITHMS' request message in DSP0274.  If the algorithm is an extended algorithm, this property shall contain the value `OEM`.  This property shall not be present if MeasurementSpecification does not contain `DMTF`.",
849*d125652eSGunnar Mills                    "readonly": true,
850*d125652eSGunnar Mills                    "type": [
851*d125652eSGunnar Mills                        "string",
852*d125652eSGunnar Mills                        "null"
853*d125652eSGunnar Mills                    ]
854*d125652eSGunnar Mills                },
855*d125652eSGunnar Mills                "MeasurementIndex": {
856*d125652eSGunnar Mills                    "description": "The index of the measurement.",
857*d125652eSGunnar Mills                    "longDescription": "This property shall contain the index of the measurement.",
858*d125652eSGunnar Mills                    "readonly": true,
859*d125652eSGunnar Mills                    "type": [
860*d125652eSGunnar Mills                        "integer",
861*d125652eSGunnar Mills                        "null"
862*d125652eSGunnar Mills                    ]
863*d125652eSGunnar Mills                },
864*d125652eSGunnar Mills                "MeasurementType": {
865*d125652eSGunnar Mills                    "anyOf": [
866*d125652eSGunnar Mills                        {
867*d125652eSGunnar Mills                            "$ref": "#/definitions/DMTFmeasurementTypes"
868*d125652eSGunnar Mills                        },
869*d125652eSGunnar Mills                        {
870*d125652eSGunnar Mills                            "type": "null"
871*d125652eSGunnar Mills                        }
872*d125652eSGunnar Mills                    ],
873*d125652eSGunnar Mills                    "description": "The type or characteristics of the data that this measurement represents.",
874*d125652eSGunnar Mills                    "longDescription": "This property shall contain the type or characteristics of the data that this measurement represents.  This property shall not be present if MeasurementSpecification does not contain `DMTF`.",
875*d125652eSGunnar Mills                    "readonly": true
876*d125652eSGunnar Mills                },
877*d125652eSGunnar Mills                "Oem": {
878*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
879*d125652eSGunnar Mills                    "description": "The OEM extension property.",
880*d125652eSGunnar Mills                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
881*d125652eSGunnar Mills                },
882*d125652eSGunnar Mills                "PartofSummaryHash": {
883*d125652eSGunnar Mills                    "description": "Indicates whether this measurement is part of the measurement summary.",
884*d125652eSGunnar Mills                    "longDescription": "This property shall indicate if this measurement is part of the measurement summary in the `MeasurementSummary` property.  If this property is not present, it shall be assumed to be `false`.",
885*d125652eSGunnar Mills                    "readonly": true,
886*d125652eSGunnar Mills                    "type": [
887*d125652eSGunnar Mills                        "boolean",
888*d125652eSGunnar Mills                        "null"
889*d125652eSGunnar Mills                    ]
890*d125652eSGunnar Mills                },
891*d125652eSGunnar Mills                "SecurityVersionNumber": {
892*d125652eSGunnar Mills                    "description": "The security version number the measurement represents.",
893*d125652eSGunnar Mills                    "longDescription": "This property shall contain an 8-byte hex-encoded string of the security version number the measurement represents.  This property shall only be present if `MeasurementType` contains the value `MutableFirmwareSecurityVersionNumber`.",
894*d125652eSGunnar Mills                    "pattern": "^[A-Za-z0-9]{16}$",
895*d125652eSGunnar Mills                    "readonly": true,
896*d125652eSGunnar Mills                    "type": [
897*d125652eSGunnar Mills                        "string",
898*d125652eSGunnar Mills                        "null"
899*d125652eSGunnar Mills                    ],
900*d125652eSGunnar Mills                    "versionAdded": "v1_1_0"
901*d125652eSGunnar Mills                }
902*d125652eSGunnar Mills            },
903*d125652eSGunnar Mills            "type": "object"
904*d125652eSGunnar Mills        },
905*d125652eSGunnar Mills        "SecureSessionType": {
906*d125652eSGunnar Mills            "enum": [
907*d125652eSGunnar Mills                "Plain",
908*d125652eSGunnar Mills                "EncryptedAuthenticated",
909*d125652eSGunnar Mills                "AuthenticatedOnly"
910*d125652eSGunnar Mills            ],
911*d125652eSGunnar Mills            "enumDescriptions": {
912*d125652eSGunnar Mills                "AuthenticatedOnly": "An established session where only authentication is protecting the communication.",
913*d125652eSGunnar Mills                "EncryptedAuthenticated": "An established session where both encryption and authentication are protecting the communication.",
914*d125652eSGunnar Mills                "Plain": "A plain text session without any protection."
915*d125652eSGunnar Mills            },
916*d125652eSGunnar Mills            "type": "string"
917*d125652eSGunnar Mills        },
918*d125652eSGunnar Mills        "SingleSessionInfo": {
919*d125652eSGunnar Mills            "additionalProperties": false,
920*d125652eSGunnar Mills            "description": "Information about a single communication channel or session between two components.",
921*d125652eSGunnar Mills            "longDescription": "This object shall contain information about a single communication channel or session between two components.",
922*d125652eSGunnar Mills            "patternProperties": {
923*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
924*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
925*d125652eSGunnar Mills                    "type": [
926*d125652eSGunnar Mills                        "array",
927*d125652eSGunnar Mills                        "boolean",
928*d125652eSGunnar Mills                        "integer",
929*d125652eSGunnar Mills                        "number",
930*d125652eSGunnar Mills                        "null",
931*d125652eSGunnar Mills                        "object",
932*d125652eSGunnar Mills                        "string"
933*d125652eSGunnar Mills                    ]
934*d125652eSGunnar Mills                }
935*d125652eSGunnar Mills            },
936*d125652eSGunnar Mills            "properties": {
937*d125652eSGunnar Mills                "SessionId": {
938*d125652eSGunnar Mills                    "description": "The identifier for an active session or communication channel between two components.",
939*d125652eSGunnar Mills                    "longDescription": "This property shall contain the unique identifier for the active session or communication channel between two components.",
940*d125652eSGunnar Mills                    "readonly": true,
941*d125652eSGunnar Mills                    "type": [
942*d125652eSGunnar Mills                        "integer",
943*d125652eSGunnar Mills                        "null"
944*d125652eSGunnar Mills                    ]
945*d125652eSGunnar Mills                },
946*d125652eSGunnar Mills                "SessionType": {
947*d125652eSGunnar Mills                    "anyOf": [
948*d125652eSGunnar Mills                        {
949*d125652eSGunnar Mills                            "$ref": "#/definitions/SecureSessionType"
950*d125652eSGunnar Mills                        },
951*d125652eSGunnar Mills                        {
952*d125652eSGunnar Mills                            "type": "null"
953*d125652eSGunnar Mills                        }
954*d125652eSGunnar Mills                    ],
955*d125652eSGunnar Mills                    "description": "The type of session or communication channel between two components.",
956*d125652eSGunnar Mills                    "longDescription": "This property shall contain the type of session or communication channel between two components.",
957*d125652eSGunnar Mills                    "readonly": true
958*d125652eSGunnar Mills                }
959*d125652eSGunnar Mills            },
960*d125652eSGunnar Mills            "type": "object"
961*d125652eSGunnar Mills        },
962*d125652eSGunnar Mills        "TPMGetSignedMeasurements": {
963*d125652eSGunnar Mills            "actionResponse": {
964*d125652eSGunnar Mills                "$ref": "#/definitions/TPMGetSignedMeasurementsResponse"
965*d125652eSGunnar Mills            },
966*d125652eSGunnar Mills            "additionalProperties": false,
967*d125652eSGunnar Mills            "description": "This action generates a TPM cryptographic signed statement over the given nonce and PCRs of the TPM for TPM 2.0 devices.",
968*d125652eSGunnar Mills            "longDescription": "This action shall generate a cryptographic signed statement over the given nonce and PCRs of the TPM for TPM 2.0 devices.  This action shall not be present if the `ComponentIntegrityType` property does not contain the value `TPM`.",
969*d125652eSGunnar Mills            "parameters": {
970*d125652eSGunnar Mills                "Certificate": {
971*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate",
972*d125652eSGunnar Mills                    "description": "The URI for the certificate that represents the TPM attestation key.",
973*d125652eSGunnar Mills                    "longDescription": "This parameter shall contain the reference to the certificate installed on the TPM that represents the TPM's attestation key for the 'signHandle' parameter of the 'TPM2_Quote' command defined in the Trusted Platform Module Library Specification.",
974*d125652eSGunnar Mills                    "requiredParameter": true
975*d125652eSGunnar Mills                },
976*d125652eSGunnar Mills                "Nonce": {
977*d125652eSGunnar Mills                    "description": "A set of bytes as a hex-encoded string that is signed with the measurements.  The value should be unique.",
978*d125652eSGunnar Mills                    "longDescription": "This parameter shall contain a set of bytes as a hex-encoded string that is signed with the measurements.  Services shall reject the action request if the number of bytes provided is larger than the value specified by the `NonceSizeBytesMaximum` property in the `TPM` property.  If not provided by the client, the service shall generate the nonce.  The value should be unique and generated using a random or a pseudo-random generator.  The service shall send this value to the TPM in the 'qualifyingData' parameter of the 'TPM2_Quote' command defined in the Trusted Platform Module Library Specification.",
979*d125652eSGunnar Mills                    "pattern": "^[0-9a-fA-F]$",
980*d125652eSGunnar Mills                    "type": "string"
981*d125652eSGunnar Mills                },
982*d125652eSGunnar Mills                "PCRSelection": {
983*d125652eSGunnar Mills                    "description": "An object that identifies the PCRs to sign.",
984*d125652eSGunnar Mills                    "longDescription": "This parameter shall contain a Base64-encoded string, with padding characters, of the 'TPML_PCR_SELECTION' object as defined by the Trusted Platform Module Library Specification, that identifies the PCRs to sign.  The service shall send this value to the TPM in the 'PCRselect' parameter of the 'TPM2_Quote' command defined in the Trusted Platform Module Library Specification.",
985*d125652eSGunnar Mills                    "requiredParameter": true,
986*d125652eSGunnar Mills                    "type": "string"
987*d125652eSGunnar Mills                },
988*d125652eSGunnar Mills                "Scheme": {
989*d125652eSGunnar Mills                    "description": "The signing scheme to use for the TPM attestation key.",
990*d125652eSGunnar Mills                    "longDescription": "This parameter shall contain a Base64-encoded string, with padding characters, of the 'TPMT_SIG_SCHEME' object as defined in the Trusted Platform Module Library Specification, that identifies the signing scheme to use for the TPM attestation key.  The service shall send this value to the TPM in the 'inScheme' parameter of the 'TPM2_Quote' command defined in the Trusted Platform Module Library Specification.",
991*d125652eSGunnar Mills                    "requiredParameter": true,
992*d125652eSGunnar Mills                    "type": "string"
993*d125652eSGunnar Mills                }
994*d125652eSGunnar Mills            },
995*d125652eSGunnar Mills            "patternProperties": {
996*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
997*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
998*d125652eSGunnar Mills                    "type": [
999*d125652eSGunnar Mills                        "array",
1000*d125652eSGunnar Mills                        "boolean",
1001*d125652eSGunnar Mills                        "integer",
1002*d125652eSGunnar Mills                        "number",
1003*d125652eSGunnar Mills                        "null",
1004*d125652eSGunnar Mills                        "object",
1005*d125652eSGunnar Mills                        "string"
1006*d125652eSGunnar Mills                    ]
1007*d125652eSGunnar Mills                }
1008*d125652eSGunnar Mills            },
1009*d125652eSGunnar Mills            "properties": {
1010*d125652eSGunnar Mills                "target": {
1011*d125652eSGunnar Mills                    "description": "Link to invoke action",
1012*d125652eSGunnar Mills                    "format": "uri-reference",
1013*d125652eSGunnar Mills                    "type": "string"
1014*d125652eSGunnar Mills                },
1015*d125652eSGunnar Mills                "title": {
1016*d125652eSGunnar Mills                    "description": "Friendly action name",
1017*d125652eSGunnar Mills                    "type": "string"
1018*d125652eSGunnar Mills                }
1019*d125652eSGunnar Mills            },
1020*d125652eSGunnar Mills            "type": "object",
1021*d125652eSGunnar Mills            "versionAdded": "v1_2_0"
1022*d125652eSGunnar Mills        },
1023*d125652eSGunnar Mills        "TPMGetSignedMeasurementsResponse": {
1024*d125652eSGunnar Mills            "additionalProperties": false,
1025*d125652eSGunnar Mills            "description": "The TPM signed measurement from a TPM.",
1026*d125652eSGunnar Mills            "longDescription": "This object shall contain the TPM signed PCR measurements from a TPM.",
1027*d125652eSGunnar Mills            "patternProperties": {
1028*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
1029*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
1030*d125652eSGunnar Mills                    "type": [
1031*d125652eSGunnar Mills                        "array",
1032*d125652eSGunnar Mills                        "boolean",
1033*d125652eSGunnar Mills                        "integer",
1034*d125652eSGunnar Mills                        "number",
1035*d125652eSGunnar Mills                        "null",
1036*d125652eSGunnar Mills                        "object",
1037*d125652eSGunnar Mills                        "string"
1038*d125652eSGunnar Mills                    ]
1039*d125652eSGunnar Mills                }
1040*d125652eSGunnar Mills            },
1041*d125652eSGunnar Mills            "properties": {
1042*d125652eSGunnar Mills                "Oem": {
1043*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
1044*d125652eSGunnar Mills                    "description": "The OEM extension property.",
1045*d125652eSGunnar Mills                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements.",
1046*d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
1047*d125652eSGunnar Mills                },
1048*d125652eSGunnar Mills                "SignedMeasurements": {
1049*d125652eSGunnar Mills                    "description": "The Base64-encoded cryptographic signed statement generated by the signer.",
1050*d125652eSGunnar Mills                    "longDescription": "This property shall contain a Base64-encoded string, with padding characters, of the cryptographic signed statement generated by the signer.  This value shall be the concatenation of the 'quoted' and 'signature' response values of the 'TPM2_Quote' command defined in the Trusted Platform Module Library Specification.",
1051*d125652eSGunnar Mills                    "readonly": true,
1052*d125652eSGunnar Mills                    "type": "string",
1053*d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
1054*d125652eSGunnar Mills                }
1055*d125652eSGunnar Mills            },
1056*d125652eSGunnar Mills            "required": [
1057*d125652eSGunnar Mills                "SignedMeasurements"
1058*d125652eSGunnar Mills            ],
1059*d125652eSGunnar Mills            "type": "object"
1060*d125652eSGunnar Mills        },
1061*d125652eSGunnar Mills        "TPMauth": {
1062*d125652eSGunnar Mills            "additionalProperties": false,
1063*d125652eSGunnar Mills            "description": "Common Authentication information.",
1064*d125652eSGunnar Mills            "longDescription": "This object shall contain common identity-related authentication information.",
1065*d125652eSGunnar Mills            "patternProperties": {
1066*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
1067*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
1068*d125652eSGunnar Mills                    "type": [
1069*d125652eSGunnar Mills                        "array",
1070*d125652eSGunnar Mills                        "boolean",
1071*d125652eSGunnar Mills                        "integer",
1072*d125652eSGunnar Mills                        "number",
1073*d125652eSGunnar Mills                        "null",
1074*d125652eSGunnar Mills                        "object",
1075*d125652eSGunnar Mills                        "string"
1076*d125652eSGunnar Mills                    ]
1077*d125652eSGunnar Mills                }
1078*d125652eSGunnar Mills            },
1079*d125652eSGunnar Mills            "properties": {
1080*d125652eSGunnar Mills                "ComponentCertificate": {
1081*d125652eSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate",
1082*d125652eSGunnar Mills                    "description": "A link to the certificate that represents the identity of the component.",
1083*d125652eSGunnar Mills                    "longDescription": "This property shall contain a link to a resource of type `Certificate` that represents the identity of the component referenced by the `TargetComponentURI` property.",
1084*d125652eSGunnar Mills                    "readonly": true
1085*d125652eSGunnar Mills                },
1086*d125652eSGunnar Mills                "VerificationStatus": {
1087*d125652eSGunnar Mills                    "anyOf": [
1088*d125652eSGunnar Mills                        {
1089*d125652eSGunnar Mills                            "$ref": "#/definitions/VerificationStatus"
1090*d125652eSGunnar Mills                        },
1091*d125652eSGunnar Mills                        {
1092*d125652eSGunnar Mills                            "type": "null"
1093*d125652eSGunnar Mills                        }
1094*d125652eSGunnar Mills                    ],
1095*d125652eSGunnar Mills                    "description": "The status of the verification of the identity of the component.",
1096*d125652eSGunnar Mills                    "longDescription": "This property shall contain the status of the verification of the identity of the component referenced by the `TargetComponentURI` property.",
1097*d125652eSGunnar Mills                    "readonly": true
1098*d125652eSGunnar Mills                }
1099*d125652eSGunnar Mills            },
1100*d125652eSGunnar Mills            "type": "object"
1101*d125652eSGunnar Mills        },
1102*d125652eSGunnar Mills        "TPMcommunication": {
1103*d125652eSGunnar Mills            "additionalProperties": false,
1104*d125652eSGunnar Mills            "description": "Information about communication between two components.",
1105*d125652eSGunnar Mills            "longDescription": "This object shall contain information about communication between two components.",
1106*d125652eSGunnar Mills            "patternProperties": {
1107*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
1108*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
1109*d125652eSGunnar Mills                    "type": [
1110*d125652eSGunnar Mills                        "array",
1111*d125652eSGunnar Mills                        "boolean",
1112*d125652eSGunnar Mills                        "integer",
1113*d125652eSGunnar Mills                        "number",
1114*d125652eSGunnar Mills                        "null",
1115*d125652eSGunnar Mills                        "object",
1116*d125652eSGunnar Mills                        "string"
1117*d125652eSGunnar Mills                    ]
1118*d125652eSGunnar Mills                }
1119*d125652eSGunnar Mills            },
1120*d125652eSGunnar Mills            "properties": {
1121*d125652eSGunnar Mills                "Sessions": {
1122*d125652eSGunnar Mills                    "description": "The active sessions or communication channels between two components.",
1123*d125652eSGunnar Mills                    "items": {
1124*d125652eSGunnar Mills                        "anyOf": [
1125*d125652eSGunnar Mills                            {
1126*d125652eSGunnar Mills                                "$ref": "#/definitions/SingleSessionInfo"
1127*d125652eSGunnar Mills                            },
1128*d125652eSGunnar Mills                            {
1129*d125652eSGunnar Mills                                "type": "null"
1130*d125652eSGunnar Mills                            }
1131*d125652eSGunnar Mills                        ]
1132*d125652eSGunnar Mills                    },
1133*d125652eSGunnar Mills                    "longDescription": "This property shall contain an array of the active sessions or communication channels between two components.  The active sessions or communication channels do not reflect how future sessions or communication channels are established.",
1134*d125652eSGunnar Mills                    "type": "array"
1135*d125652eSGunnar Mills                }
1136*d125652eSGunnar Mills            },
1137*d125652eSGunnar Mills            "type": "object"
1138*d125652eSGunnar Mills        },
1139*d125652eSGunnar Mills        "TPMinfo": {
1140*d125652eSGunnar Mills            "additionalProperties": false,
1141*d125652eSGunnar Mills            "description": "Integrity information about a Trusted Platform Module (TPM).",
1142*d125652eSGunnar Mills            "longDescription": "This object shall contain integrity information about a Trusted Platform Module (TPM).",
1143*d125652eSGunnar Mills            "patternProperties": {
1144*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
1145*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
1146*d125652eSGunnar Mills                    "type": [
1147*d125652eSGunnar Mills                        "array",
1148*d125652eSGunnar Mills                        "boolean",
1149*d125652eSGunnar Mills                        "integer",
1150*d125652eSGunnar Mills                        "number",
1151*d125652eSGunnar Mills                        "null",
1152*d125652eSGunnar Mills                        "object",
1153*d125652eSGunnar Mills                        "string"
1154*d125652eSGunnar Mills                    ]
1155*d125652eSGunnar Mills                }
1156*d125652eSGunnar Mills            },
1157*d125652eSGunnar Mills            "properties": {
1158*d125652eSGunnar Mills                "ComponentCommunication": {
1159*d125652eSGunnar Mills                    "anyOf": [
1160*d125652eSGunnar Mills                        {
1161*d125652eSGunnar Mills                            "$ref": "#/definitions/TPMcommunication"
1162*d125652eSGunnar Mills                        },
1163*d125652eSGunnar Mills                        {
1164*d125652eSGunnar Mills                            "type": "null"
1165*d125652eSGunnar Mills                        }
1166*d125652eSGunnar Mills                    ],
1167*d125652eSGunnar Mills                    "description": "Information about communication with the TPM.",
1168*d125652eSGunnar Mills                    "longDescription": "This property shall contain information about communication with the TPM."
1169*d125652eSGunnar Mills                },
1170*d125652eSGunnar Mills                "IdentityAuthentication": {
1171*d125652eSGunnar Mills                    "anyOf": [
1172*d125652eSGunnar Mills                        {
1173*d125652eSGunnar Mills                            "$ref": "#/definitions/TPMauth"
1174*d125652eSGunnar Mills                        },
1175*d125652eSGunnar Mills                        {
1176*d125652eSGunnar Mills                            "type": "null"
1177*d125652eSGunnar Mills                        }
1178*d125652eSGunnar Mills                    ],
1179*d125652eSGunnar Mills                    "description": "Identity authentication information about the TPM.",
1180*d125652eSGunnar Mills                    "longDescription": "This property shall contain identity authentication information about the TPM."
1181*d125652eSGunnar Mills                },
1182*d125652eSGunnar Mills                "MeasurementSet": {
1183*d125652eSGunnar Mills                    "anyOf": [
1184*d125652eSGunnar Mills                        {
1185*d125652eSGunnar Mills                            "$ref": "#/definitions/TPMmeasurementSet"
1186*d125652eSGunnar Mills                        },
1187*d125652eSGunnar Mills                        {
1188*d125652eSGunnar Mills                            "type": "null"
1189*d125652eSGunnar Mills                        }
1190*d125652eSGunnar Mills                    ],
1191*d125652eSGunnar Mills                    "description": "Measurement information from the TPM.",
1192*d125652eSGunnar Mills                    "longDescription": "This property shall contain measurement information from the TPM."
1193*d125652eSGunnar Mills                },
1194*d125652eSGunnar Mills                "NonceSizeBytesMaximum": {
1195*d125652eSGunnar Mills                    "description": "The maximum number of bytes that can be specified in the `Nonce` parameter of the `TPMGetSignedMeasurements` action.",
1196*d125652eSGunnar Mills                    "longDescription": "This property shall contain the maximum number of bytes that can be specified in the `Nonce` parameter of the `TPMGetSignedMeasurements` action.",
1197*d125652eSGunnar Mills                    "minimum": 0,
1198*d125652eSGunnar Mills                    "readonly": true,
1199*d125652eSGunnar Mills                    "type": [
1200*d125652eSGunnar Mills                        "integer",
1201*d125652eSGunnar Mills                        "null"
1202*d125652eSGunnar Mills                    ],
1203*d125652eSGunnar Mills                    "versionAdded": "v1_2_0"
1204*d125652eSGunnar Mills                }
1205*d125652eSGunnar Mills            },
1206*d125652eSGunnar Mills            "type": "object"
1207*d125652eSGunnar Mills        },
1208*d125652eSGunnar Mills        "TPMmeasurementSet": {
1209*d125652eSGunnar Mills            "additionalProperties": false,
1210*d125652eSGunnar Mills            "description": "Trusted Computing Group TPM measurement information.",
1211*d125652eSGunnar Mills            "longDescription": "This object shall contain Trusted Computing Group TPM measurement information.",
1212*d125652eSGunnar Mills            "patternProperties": {
1213*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
1214*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
1215*d125652eSGunnar Mills                    "type": [
1216*d125652eSGunnar Mills                        "array",
1217*d125652eSGunnar Mills                        "boolean",
1218*d125652eSGunnar Mills                        "integer",
1219*d125652eSGunnar Mills                        "number",
1220*d125652eSGunnar Mills                        "null",
1221*d125652eSGunnar Mills                        "object",
1222*d125652eSGunnar Mills                        "string"
1223*d125652eSGunnar Mills                    ]
1224*d125652eSGunnar Mills                }
1225*d125652eSGunnar Mills            },
1226*d125652eSGunnar Mills            "properties": {
1227*d125652eSGunnar Mills                "Measurements": {
1228*d125652eSGunnar Mills                    "description": "Measurements from a TPM.",
1229*d125652eSGunnar Mills                    "items": {
1230*d125652eSGunnar Mills                        "anyOf": [
1231*d125652eSGunnar Mills                            {
1232*d125652eSGunnar Mills                                "$ref": "#/definitions/TPMsingleMeasurement"
1233*d125652eSGunnar Mills                            },
1234*d125652eSGunnar Mills                            {
1235*d125652eSGunnar Mills                                "type": "null"
1236*d125652eSGunnar Mills                            }
1237*d125652eSGunnar Mills                        ]
1238*d125652eSGunnar Mills                    },
1239*d125652eSGunnar Mills                    "longDescription": "This property shall contain measurements from a TPM.",
1240*d125652eSGunnar Mills                    "type": "array"
1241*d125652eSGunnar Mills                }
1242*d125652eSGunnar Mills            },
1243*d125652eSGunnar Mills            "type": "object"
1244*d125652eSGunnar Mills        },
1245*d125652eSGunnar Mills        "TPMsingleMeasurement": {
1246*d125652eSGunnar Mills            "additionalProperties": false,
1247*d125652eSGunnar Mills            "description": "A single Trusted Computing Group TPM measurement.",
1248*d125652eSGunnar Mills            "longDescription": "This object shall contain a single Trusted Computing Group TPM measurement.",
1249*d125652eSGunnar Mills            "patternProperties": {
1250*d125652eSGunnar Mills                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
1251*d125652eSGunnar Mills                    "description": "This property shall specify a valid odata or Redfish property.",
1252*d125652eSGunnar Mills                    "type": [
1253*d125652eSGunnar Mills                        "array",
1254*d125652eSGunnar Mills                        "boolean",
1255*d125652eSGunnar Mills                        "integer",
1256*d125652eSGunnar Mills                        "number",
1257*d125652eSGunnar Mills                        "null",
1258*d125652eSGunnar Mills                        "object",
1259*d125652eSGunnar Mills                        "string"
1260*d125652eSGunnar Mills                    ]
1261*d125652eSGunnar Mills                }
1262*d125652eSGunnar Mills            },
1263*d125652eSGunnar Mills            "properties": {
1264*d125652eSGunnar Mills                "LastUpdated": {
1265*d125652eSGunnar Mills                    "description": "The date and time when information for the measurement was last updated.",
1266*d125652eSGunnar Mills                    "format": "date-time",
1267*d125652eSGunnar Mills                    "longDescription": "This property shall contain the date and time when information for the measurement was last updated.",
1268*d125652eSGunnar Mills                    "readonly": true,
1269*d125652eSGunnar Mills                    "type": [
1270*d125652eSGunnar Mills                        "string",
1271*d125652eSGunnar Mills                        "null"
1272*d125652eSGunnar Mills                    ]
1273*d125652eSGunnar Mills                },
1274*d125652eSGunnar Mills                "Measurement": {
1275*d125652eSGunnar Mills                    "description": "The measurement data.",
1276*d125652eSGunnar Mills                    "longDescription": "This property shall contain a Base64-encoded string, with padding characters, of the PCR digest using the hashing algorithm indicated by the `MeasurementHashAlgorithm` property.",
1277*d125652eSGunnar Mills                    "pattern": "^[A-Za-z0-9+/]+={0,2}$",
1278*d125652eSGunnar Mills                    "readonly": true,
1279*d125652eSGunnar Mills                    "type": [
1280*d125652eSGunnar Mills                        "string",
1281*d125652eSGunnar Mills                        "null"
1282*d125652eSGunnar Mills                    ]
1283*d125652eSGunnar Mills                },
1284*d125652eSGunnar Mills                "MeasurementHashAlgorithm": {
1285*d125652eSGunnar Mills                    "description": "The hash algorithm used to compute the measurement.",
1286*d125652eSGunnar Mills                    "longDescription": "This property shall contain the hash algorithm used to compute the measurement.  The allowable values for this property shall be the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'.",
1287*d125652eSGunnar Mills                    "readonly": true,
1288*d125652eSGunnar Mills                    "type": [
1289*d125652eSGunnar Mills                        "string",
1290*d125652eSGunnar Mills                        "null"
1291*d125652eSGunnar Mills                    ]
1292*d125652eSGunnar Mills                },
1293*d125652eSGunnar Mills                "PCR": {
1294*d125652eSGunnar Mills                    "description": "The Platform Configuration Register (PCR) bank of the measurement.",
1295*d125652eSGunnar Mills                    "longDescription": "This property shall contain the Platform Configuration Register (PCR) bank of the measurement.",
1296*d125652eSGunnar Mills                    "readonly": true,
1297*d125652eSGunnar Mills                    "type": [
1298*d125652eSGunnar Mills                        "integer",
1299*d125652eSGunnar Mills                        "null"
1300*d125652eSGunnar Mills                    ]
1301*d125652eSGunnar Mills                }
1302*d125652eSGunnar Mills            },
1303*d125652eSGunnar Mills            "type": "object"
1304*d125652eSGunnar Mills        },
1305*d125652eSGunnar Mills        "VerificationStatus": {
1306*d125652eSGunnar Mills            "enum": [
1307*d125652eSGunnar Mills                "Success",
1308*d125652eSGunnar Mills                "Failed"
1309*d125652eSGunnar Mills            ],
1310*d125652eSGunnar Mills            "enumDescriptions": {
1311*d125652eSGunnar Mills                "Failed": "Unsuccessful verification.",
1312*d125652eSGunnar Mills                "Success": "Successful verification."
1313*d125652eSGunnar Mills            },
1314*d125652eSGunnar Mills            "type": "string"
1315*d125652eSGunnar Mills        }
1316*d125652eSGunnar Mills    },
1317*d125652eSGunnar Mills    "language": "en",
1318*d125652eSGunnar Mills    "owningEntity": "DMTF",
1319*d125652eSGunnar Mills    "release": "2024.3",
1320*d125652eSGunnar Mills    "title": "#ComponentIntegrity.v1_3_1.ComponentIntegrity"
1321*d125652eSGunnar Mills}