blob: 9f403741a845011c95e1e4feb99e02755db38757 [file] [log] [blame]
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Gunnar Mills10f270b2021-05-19 15:34:06 -05004<!--# Redfish Schema: Certificate v1.3.0 -->
Marri Devender Raod45d2d02019-01-21 10:11:34 -06005<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
Gunnar Mills10f270b2021-05-19 15:34:06 -05008<!--# Copyright 2014-2021 DMTF. -->
Marri Devender Raod45d2d02019-01-21 10:11:34 -06009<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21 <edmx:Include Namespace="Resource.v1_0_0"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
24 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
Gunnar Mills10f270b2021-05-19 15:34:06 -050025 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060026 </edmx:Reference>
27
28 <edmx:DataServices>
29
30 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate">
31 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
32
33 <EntityType Name="Certificate" BaseType="Resource.v1_0_0.Resource" Abstract="true">
Ed Tanouscb103132019-10-08 11:34:22 -070034 <Annotation Term="OData.Description" String="The Certificate schema describes a certificate that proves the identify of a component, account, or service."/>
Gunnar Mills844b4152020-06-22 12:44:09 -050035 <Annotation Term="OData.LongDescription" String="This resource shall represent a certificate for a Redfish implementation."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060036 <Annotation Term="Capabilities.InsertRestrictions">
37 <Record>
38 <PropertyValue Property="Insertable" Bool="false"/>
39 </Record>
40 </Annotation>
41 <Annotation Term="Capabilities.UpdateRestrictions">
42 <Record>
43 <PropertyValue Property="Updatable" Bool="false"/>
44 </Record>
45 </Annotation>
46 <Annotation Term="Capabilities.DeleteRestrictions">
47 <Record>
48 <PropertyValue Property="Deletable" Bool="true"/>
Ed Tanouscb103132019-10-08 11:34:22 -070049 <Annotation Term="OData.Description" String="Use the DELETE operation to remove certificates."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060050 </Record>
51 </Annotation>
52 <Annotation Term="Redfish.Uris">
53 <Collection>
54 <String>/redfish/v1/AccountService/Accounts/{ManagerAccountId}/Certificates/{CertificateId}</String>
55 <String>/redfish/v1/AccountService/ActiveDirectory/Certificates/{CertificateId}</String>
56 <String>/redfish/v1/AccountService/LDAP/Certificates/{CertificateId}</String>
57 <String>/redfish/v1/AccountService/ExternalAccountProviders/{ExternalAccountProviderId}/Certificates/{CertificateId}</String>
58 <String>/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/{ManagerAccountId}/Certificates/{CertificateId}</String>
59 <String>/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ActiveDirectory/Certificates/{CertificateId}</String>
60 <String>/redfish/v1/Managers/{ManagerId}/RemoteAccountService/LDAP/Certificates/{CertificateId}</String>
61 <String>/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders/{ExternalAccountProviderId}/Certificates/{CertificateId}</String>
62 <String>/redfish/v1/Managers/{ManagerId}/NetworkProtocol/HTTPS/Certificates/{CertificateId}</String>
Ed Tanouscb103132019-10-08 11:34:22 -070063 <String>/redfish/v1/Systems/{ComputerSystemId}/Boot/Certificates/{CertificateId}</String>
64 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Boot/Certificates/{CertificateId}</String>
65 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Boot/Certificates/{CertificateId}</String>
Gunnar Millsa778c022020-05-12 12:20:36 -050066 <String>/redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates/{CertificateId}</String>
67 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates/{CertificateId}</String>
68 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates/{CertificateId}</String>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -050069 <String>/redfish/v1/EventService/Subscriptions/{EventDestinationId}/Certificates/{CertificateId}</String>
Gunnar Mills262d7d42021-01-20 16:28:41 -060070 <String>/redfish/v1/Systems/{ComputerSystemId}/Certificates/{CertificateId}</String>
71 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Certificates/{CertificateId}</String>
72 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Certificates/{CertificateId}</String>
73 <String>/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates/{CertificateId}</String>
74 <String>/redfish/v1/Chassis/{ChassisId}/Memory/{MemoryId}/Certificates/{CertificateId}</String>
75 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Certificates/{CertificateId}</String>
76 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates/{CertificateId}</String>
77 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Certificates/{CertificateId}</String>
78 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates/{CertificateId}</String>
79 <String>/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates/{CertificateId}</String>
80 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Certificates/{CertificateId}</String>
81 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates/{CertificateId}</String>
82 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Certificates/{CertificateId}</String>
83 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates/{CertificateId}</String>
84 <String>/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}</String>
85 <String>/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}</String>
86 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}</String>
87 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}</String>
88 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}</String>
89 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}</String>
90 <String>/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}</String>
91 <String>/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}</String>
92 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}</String>
93 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}</String>
94 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}</String>
95 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}</String>
96 <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Certificates/{CertificateId}</String>
97 <String>/redfish/v1/Chassis/{ChassisId}/Certificates/{CertificateId}</String>
98 <String>/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}</String>
99 <String>/redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}/Certificates/{CertificateId}</String>
100 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}</String>
101 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Certificates/{CertificateId}</String>
102 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}</String>
103 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}</String>
104 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Certificates/{CertificateId}</String>
105 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}</String>
106 <String>/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Certificates/{CertificateId}</String>
Gunnar Mills10f270b2021-05-19 15:34:06 -0500107 <String>/redfish/v1/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates/{CertificateId}</String>
108 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates/{CertificateId}</String>
109 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates/{CertificateId}</String>
110 <String>/redfish/v1/UpdateService/RemoteServerCertificates/{CertificateId}</String>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600111 </Collection>
112 </Annotation>
113 </EntityType>
114
115 <EnumType Name="CertificateType">
116 <Member Name="PEM">
Ed Tanouscb103132019-10-08 11:34:22 -0700117 <Annotation Term="OData.Description" String="A Privacy Enhanced Mail (PEM)-encoded certificate."/>
118 <Annotation Term="OData.LongDescription" String="The format of the certificate shall contain a Privacy Enhanced Mail (PEM)-encoded string, containing RFC5280-defined structures."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600119 </Member>
120 <Member Name="PKCS7">
Ed Tanouscb103132019-10-08 11:34:22 -0700121 <Annotation Term="OData.Description" String="A Privacy Enhanced Mail (PEM)-encoded PKCS7 certificate."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500122 <Annotation Term="OData.LongDescription" String="The format of the certificate shall contain a Privacy Enhanced Mail (PEM)-encoded string, containing RFC5280- and RFC2315-defined structures. The service can discard additional certificates or other data in the structure."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600123 </Member>
124 </EnumType>
125
126 <EnumType Name="KeyUsage">
127 <Annotation Term="OData.Description" String="The usages of a key contained within a certificate."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700128 <Annotation Term="OData.LongDescription" String="This type shall describe the usages of a key within a certificate, as specified by the 'Key Usage' and 'Extended Key Usage' definitions in RFC5280."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600129 <Member Name="DigitalSignature">
Ed Tanouscb103132019-10-08 11:34:22 -0700130 <Annotation Term="OData.Description" String="Verifies digital signatures, other than signatures on certificates and CRLs."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600131 </Member>
132 <Member Name="NonRepudiation">
Ed Tanouscb103132019-10-08 11:34:22 -0700133 <Annotation Term="OData.Description" String="Verifies digital signatures, other than signatures on certificates and CRLs, and provides a non-repudiation service that protects against the signing entity falsely denying some action."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600134 </Member>
135 <Member Name="KeyEncipherment">
Ed Tanouscb103132019-10-08 11:34:22 -0700136 <Annotation Term="OData.Description" String="Enciphers private or secret keys."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600137 </Member>
138 <Member Name="DataEncipherment">
Ed Tanouscb103132019-10-08 11:34:22 -0700139 <Annotation Term="OData.Description" String="Directly enciphers raw user data without an intermediate symmetric cipher."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600140 </Member>
141 <Member Name="KeyAgreement">
Ed Tanouscb103132019-10-08 11:34:22 -0700142 <Annotation Term="OData.Description" String="Key agreement."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600143 </Member>
144 <Member Name="KeyCertSign">
Ed Tanouscb103132019-10-08 11:34:22 -0700145 <Annotation Term="OData.Description" String="Verifies signatures on public key certificates."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600146 </Member>
147 <Member Name="CRLSigning">
Gunnar Millsa778c022020-05-12 12:20:36 -0500148 <Annotation Term="OData.Description" String="Verifies signatures on certificate revocation lists (CRLs)."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600149 </Member>
150 <Member Name="EncipherOnly">
Ed Tanouscb103132019-10-08 11:34:22 -0700151 <Annotation Term="OData.Description" String="Enciphers data while performing a key agreement."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600152 </Member>
153 <Member Name="DecipherOnly">
Ed Tanouscb103132019-10-08 11:34:22 -0700154 <Annotation Term="OData.Description" String="Deciphers data while performing a key agreement."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600155 </Member>
156 <Member Name="ServerAuthentication">
Ed Tanouscb103132019-10-08 11:34:22 -0700157 <Annotation Term="OData.Description" String="TLS WWW server authentication."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600158 </Member>
159 <Member Name="ClientAuthentication">
Ed Tanouscb103132019-10-08 11:34:22 -0700160 <Annotation Term="OData.Description" String="TLS WWW client authentication."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600161 </Member>
162 <Member Name="CodeSigning">
Ed Tanouscb103132019-10-08 11:34:22 -0700163 <Annotation Term="OData.Description" String="Signs downloadable executable code."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600164 </Member>
165 <Member Name="EmailProtection">
Ed Tanouscb103132019-10-08 11:34:22 -0700166 <Annotation Term="OData.Description" String="Email protection."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600167 </Member>
168 <Member Name="Timestamping">
Ed Tanouscb103132019-10-08 11:34:22 -0700169 <Annotation Term="OData.Description" String="Binds the hash of an object to a time."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600170 </Member>
171 <Member Name="OCSPSigning">
Ed Tanouscb103132019-10-08 11:34:22 -0700172 <Annotation Term="OData.Description" String="Signs OCSP responses."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600173 </Member>
174 </EnumType>
Ed Tanouscb103132019-10-08 11:34:22 -0700175
176 <Action Name="Rekey" IsBound="true">
Gunnar Mills844b4152020-06-22 12:44:09 -0500177 <Annotation Term="OData.Description" String="This action generates a new key-pair for a certificate and produces a certificate signing request."/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600178 <Annotation Term="OData.LongDescription" String="This action shall use the certificate data to generate a new key-pair for a certificate. The response shall contain a signing request that a certificate authority (CA) will sign. The service should retain the private key that generated this request for installation of the certificate. The private key should not be part of the response. The private key should not be part of the response."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700179 <Parameter Name="Certificate" Type="Certificate.v1_0_0.Actions"/>
180 <Parameter Name="KeyPairAlgorithm" Type="Edm.String">
181 <Annotation Term="OData.Description" String="The type of key-pair for use with signing algorithms."/>
182 <Annotation Term="OData.LongDescription" String="This parameter shall contain the type of key-pair for use with signing algorithms. The allowable values for this parameter shall be the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'."/>
183 </Parameter>
184 <Parameter Name="KeyBitLength" Type="Edm.Int64">
185 <Annotation Term="OData.Description" String="The length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value."/>
186 <Annotation Term="OData.LongDescription" String="This parameter shall contain the length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value."/>
187 </Parameter>
188 <Parameter Name="KeyCurveId" Type="Edm.String">
189 <Annotation Term="OData.Description" String="The curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value."/>
190 <Annotation Term="OData.LongDescription" String="This parameter shall contain the curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value. The allowable values for this parameter shall be the strings in the 'Name' field of the 'TPM_ECC_CURVE Constants' table within the 'Trusted Computing Group Algorithm Registry'."/>
191 </Parameter>
192 <Parameter Name="ChallengePassword" Type="Edm.String">
193 <Annotation Term="OData.Description" String="The challenge password to apply to the certificate for revocation requests."/>
194 <Annotation Term="OData.LongDescription" String="This property shall contain the challenge password to apply to the certificate for revocation requests as defined by the RFC2985 'challengePassword' attribute."/>
195 </Parameter>
196 <ReturnType Type="Certificate.v1_1_0.RekeyResponse" Nullable="false"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700197 <Annotation Term="Redfish.Revisions">
198 <Collection>
199 <Record>
200 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
201 <PropertyValue Property="Version" String="v1_1_0"/>
202 </Record>
203 </Collection>
204 </Annotation>
205 </Action>
206
207 <Action Name="Renew" IsBound="true">
Gunnar Mills844b4152020-06-22 12:44:09 -0500208 <Annotation Term="OData.Description" String="This action generates a certificate signing request by using the existing information and key-pair of the certificate."/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600209 <Annotation Term="OData.LongDescription" String="This action shall generate a certificate signing request using the existing information and key-pair of the certificate. The response shall contain a signing request that a certificate authority (CA) will sign. The service should retain the private key that this request generates for when the certificate is installed. The private key should not be part of the response."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700210 <Parameter Name="Certificate" Type="Certificate.v1_0_0.Actions"/>
211 <Parameter Name="ChallengePassword" Type="Edm.String">
212 <Annotation Term="OData.Description" String="The challenge password to apply to the certificate for revocation requests."/>
213 <Annotation Term="OData.LongDescription" String="This property shall contain the challenge password to apply to the certificate for revocation requests as defined by the RFC2985 'challengePassword' attribute."/>
214 </Parameter>
215 <ReturnType Type="Certificate.v1_1_0.RenewResponse" Nullable="false"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700216 <Annotation Term="Redfish.Revisions">
217 <Collection>
218 <Record>
219 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
220 <PropertyValue Property="Version" String="v1_1_0"/>
221 </Record>
222 </Collection>
223 </Annotation>
224 </Action>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600225 </Schema>
226
227 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_0_0">
228 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
229 <Annotation Term="Redfish.Release" String="2018.3"/>
230
231 <EntityType Name="Certificate" BaseType="Certificate.Certificate">
232 <Property Name="CertificateString" Type="Edm.String">
233 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
234 <Annotation Term="OData.Description" String="The string for the certificate."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700235 <Annotation Term="OData.LongDescription" String="This property shall contain the certificate, and the format shall follow the requirements specified by the CertificateType property value. If the certificate contains any private keys, they shall be removed from the string in responses. If the service does not know the private key for the certificate and is needed to use the certificate, the client shall provide the private key as part of the string in the POST request."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600236 <Annotation Term="Redfish.RequiredOnCreate"/>
237 </Property>
238 <Property Name="CertificateType" Type="Certificate.CertificateType">
239 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
240 <Annotation Term="OData.Description" String="The format of the certificate."/>
241 <Annotation Term="OData.LongDescription" String="This property shall contain the format type for the certificate."/>
242 <Annotation Term="Redfish.RequiredOnCreate"/>
243 </Property>
244 <Property Name="Issuer" Type="Certificate.v1_0_0.Identifier" Nullable="false">
245 <Annotation Term="OData.Description" String="The issuer of the certificate."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700246 <Annotation Term="OData.LongDescription" String="This property shall contain an object containing information about the issuer of the certificate."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600247 </Property>
248 <Property Name="Subject" Type="Certificate.v1_0_0.Identifier" Nullable="false">
249 <Annotation Term="OData.Description" String="The subject of the certificate."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700250 <Annotation Term="OData.LongDescription" String="This property shall contain an object containing information about the subject of the certificate."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600251 </Property>
252 <Property Name="ValidNotBefore" Type="Edm.DateTimeOffset" Nullable="false">
253 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
254 <Annotation Term="OData.Description" String="The date when the certificate becomes valid."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700255 <Annotation Term="OData.LongDescription" String="This property shall contain the date when the certificate validity period begins."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600256 </Property>
257 <Property Name="ValidNotAfter" Type="Edm.DateTimeOffset" Nullable="false">
258 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
259 <Annotation Term="OData.Description" String="The date when the certificate is no longer valid."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700260 <Annotation Term="OData.LongDescription" String="This property shall contain the date when the certificate validity period ends."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600261 </Property>
262 <Property Name="KeyUsage" Type="Collection(Certificate.KeyUsage)">
263 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700264 <Annotation Term="OData.Description" String="The key usage extension, which defines the purpose of the public keys in this certificate."/>
265 <Annotation Term="OData.LongDescription" String="This property shall contain the key usage extension, which defines the purpose of the public keys in this certificate."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600266 </Property>
267
268 <Property Name="Actions" Type="Certificate.v1_0_0.Actions" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500269 <Annotation Term="OData.Description" String="The available actions for this resource."/>
270 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600271 </Property>
272 </EntityType>
273
274 <ComplexType Name="Identifier">
275 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
276 <Annotation Term="OData.Description" String="The identifier information about a certificate."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700277 <Annotation Term="OData.LongDescription" String="This type shall contain the properties that identifies the issuer or subject of a certificate."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600278 <Property Name="CommonName" Type="Edm.String" Nullable="false">
279 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
280 <Annotation Term="OData.Description" String="The fully qualified domain name of the entity."/>
281 <Annotation Term="OData.LongDescription" String="This property shall contain the fully qualified domain name of the entity."/>
282 </Property>
283 <Property Name="Organization" Type="Edm.String" Nullable="false">
284 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
285 <Annotation Term="OData.Description" String="The name of the organization of the entity."/>
286 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the organization of the entity."/>
287 </Property>
288 <Property Name="OrganizationalUnit" Type="Edm.String" Nullable="false">
289 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
290 <Annotation Term="OData.Description" String="The name of the unit or division of the organization of the entity."/>
291 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the unit or division of the organization of the entity."/>
292 </Property>
293 <Property Name="City" Type="Edm.String" Nullable="false">
294 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
295 <Annotation Term="OData.Description" String="The city or locality of the organization of the entity."/>
296 <Annotation Term="OData.LongDescription" String="This property shall contain the city or locality of the organization of the entity."/>
297 </Property>
298 <Property Name="State" Type="Edm.String" Nullable="false">
299 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
300 <Annotation Term="OData.Description" String="The state, province, or region of the organization of the entity."/>
301 <Annotation Term="OData.LongDescription" String="This property shall contain the state, province, or region of the organization of the entity."/>
302 </Property>
303 <Property Name="Country" Type="Edm.String" Nullable="false">
304 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
305 <Annotation Term="OData.Description" String="The country of the organization of the entity."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700306 <Annotation Term="OData.LongDescription" String="This property shall contain the two-letter ISO code for the country of the organization of the entity."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600307 </Property>
308 <Property Name="Email" Type="Edm.String">
309 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
310 <Annotation Term="OData.Description" String="The email address of the contact within the organization of the entity."/>
311 <Annotation Term="OData.LongDescription" String="This property shall contain the email address of the contact within the organization of the entity."/>
312 </Property>
313 </ComplexType>
314
315 <ComplexType Name="Actions">
316 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500317 <Annotation Term="OData.Description" String="The available actions for this resource."/>
318 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600319 <Property Name="Oem" Type="Certificate.v1_0_0.OemActions" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500320 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
321 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600322 </Property>
323 </ComplexType>
324
325 <ComplexType Name="OemActions">
326 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500327 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
328 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600329 </ComplexType>
330 </Schema>
331
Ed Tanouscb103132019-10-08 11:34:22 -0700332 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_0_1">
333 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
334 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
335 <EntityType Name="Certificate" BaseType="Certificate.v1_0_0.Certificate"/>
336 </Schema>
337
338 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_0_2">
339 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
340 <Annotation Term="OData.Description" String="This version was created to update the CertificateString description. It was also created to update descriptions that this schema defines."/>
341 <EntityType Name="Certificate" BaseType="Certificate.v1_0_1.Certificate"/>
342 </Schema>
343
Gunnar Mills844b4152020-06-22 12:44:09 -0500344 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_0_3">
345 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
346 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
347 <EntityType Name="Certificate" BaseType="Certificate.v1_0_2.Certificate"/>
348 </Schema>
349
Gunnar Mills262d7d42021-01-20 16:28:41 -0600350 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_0_4">
351 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
352 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
353 <EntityType Name="Certificate" BaseType="Certificate.v1_0_3.Certificate"/>
354 </Schema>
355
Ed Tanouscb103132019-10-08 11:34:22 -0700356 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_1_0">
357 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
358 <Annotation Term="Redfish.Release" String="2019.1"/>
359 <Annotation Term="OData.Description" String="This version was created to add the Renew and Rekey actions."/>
360 <EntityType Name="Certificate" BaseType="Certificate.v1_0_1.Certificate"/>
361
362 <ComplexType Name="RekeyResponse">
363 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
364 <Annotation Term="OData.Description" String="The response body for the Rekey action."/>
365 <Annotation Term="OData.LongDescription" String="This type shall contain the properties found in the response body for the Rekey action."/>
366 <NavigationProperty Name="Certificate" Type="Certificate.Certificate" Nullable="false">
367 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
368 <Annotation Term="OData.Description" String="The link to the certificate being rekeyed."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500369 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type Certificate that is replaced after the certificate authority (CA) signs the certificate."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700370 <Annotation Term="Redfish.Required"/>
371 </NavigationProperty>
372 <Property Name="CSRString" Type="Edm.String" Nullable="false">
373 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
374 <Annotation Term="OData.Description" String="The string for the certificate signing request."/>
375 <Annotation Term="OData.LongDescription" String="This property shall contain the certificate signing request as a PEM-encoded string, containing structures specified by RFC2986. The private key should not be part of the string."/>
376 <Annotation Term="Redfish.Required"/>
377 </Property>
378 </ComplexType>
379
380 <ComplexType Name="RenewResponse">
381 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
382 <Annotation Term="OData.Description" String="The response body for the Renew action."/>
383 <Annotation Term="OData.LongDescription" String="This type shall contain the properties found in the response body for the Renew action."/>
384 <NavigationProperty Name="Certificate" Type="Certificate.Certificate" Nullable="false">
385 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
386 <Annotation Term="OData.Description" String="The link to the certificate being renewed."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500387 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type Certificate that is replaced after the certificate authority (CA) signs the certificate."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700388 <Annotation Term="Redfish.Required"/>
389 </NavigationProperty>
390 <Property Name="CSRString" Type="Edm.String" Nullable="false">
391 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
392 <Annotation Term="OData.Description" String="The string for the certificate signing request."/>
393 <Annotation Term="OData.LongDescription" String="This property shall contain the certificate signing request as a PEM-encoded string, containing structures specified by RFC2986. The private key should not be part of the string."/>
394 <Annotation Term="Redfish.Required"/>
395 </Property>
396 </ComplexType>
397 </Schema>
398
399 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_1_1">
400 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
401 <Annotation Term="OData.Description" String="This version was created to update the CertificateString description. It was also created to update descriptions that this schema defines."/>
402 <EntityType Name="Certificate" BaseType="Certificate.v1_1_0.Certificate"/>
403 </Schema>
404
Gunnar Mills844b4152020-06-22 12:44:09 -0500405 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_1_2">
406 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
407 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
408 <EntityType Name="Certificate" BaseType="Certificate.v1_1_1.Certificate"/>
409 </Schema>
410
Gunnar Mills262d7d42021-01-20 16:28:41 -0600411 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_1_3">
412 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
413 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
414 <EntityType Name="Certificate" BaseType="Certificate.v1_1_2.Certificate"/>
415 </Schema>
416
Gunnar Millsa778c022020-05-12 12:20:36 -0500417 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_2_0">
418 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
419 <Annotation Term="Redfish.Release" String="2020.1"/>
420
421 <EntityType Name="Certificate" BaseType="Certificate.v1_1_1.Certificate">
422 <Property Name="UefiSignatureOwner" Type="Edm.Guid">
423 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
424 <Annotation Term="OData.Description" String="The UEFI signature owner for this certificate."/>
Gunnar Mills10f270b2021-05-19 15:34:06 -0500425 <Annotation Term="OData.LongDescription" String="The value of this property shall contain the GUID of the UEFI signature owner for this certificate as defined by the UEFI Specification. This property shall only be present for certificates managed by UEFI."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500426 </Property>
427 </EntityType>
428 </Schema>
429
Gunnar Mills844b4152020-06-22 12:44:09 -0500430 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_2_1">
431 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
432 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
433 <EntityType Name="Certificate" BaseType="Certificate.v1_2_0.Certificate"/>
434 </Schema>
435
Gunnar Mills262d7d42021-01-20 16:28:41 -0600436 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_2_2">
437 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
438 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
439 <EntityType Name="Certificate" BaseType="Certificate.v1_2_1.Certificate"/>
440 </Schema>
441
Gunnar Mills10f270b2021-05-19 15:34:06 -0500442 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_2_3">
443 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
444 <Annotation Term="OData.Description" String="This version was created to clarify the usage of UefiSignatureOwner for all certificates managed by UEFI."/>
445 <EntityType Name="Certificate" BaseType="Certificate.v1_2_2.Certificate"/>
446 </Schema>
447
448 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Certificate.v1_3_0">
449 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
450 <Annotation Term="Redfish.Release" String="2021.1"/>
451
452 <EntityType Name="Certificate" BaseType="Certificate.v1_2_3.Certificate">
453 <Property Name="SerialNumber" Type="Edm.String" Nullable="false">
454 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
455 <Annotation Term="OData.Description" String="The serial number of the certificate."/>
456 <Annotation Term="OData.LongDescription" String="The value of this property shall be a string containing the ASCII representation of the serial number of the certificate, as defined by the RFC5280 'serialNumber' field."/>
457 <Annotation Term="Validation.Pattern" String="^([0-9A-Fa-f]{2}:){0,}([0-9A-Fa-f]{2})$"/>
458 </Property>
459 <Property Name="Fingerprint" Type="Edm.String" Nullable="false">
460 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
461 <Annotation Term="OData.Description" String="The fingerprint of the certificate."/>
462 <Annotation Term="OData.LongDescription" String="The value of this property shall be a string containing the ASCII representation of the fingerprint of the certificate. The hash algorithm used to generate this fingerprint shall be specified by the FingerprintHashAlgorithm property."/>
463 <Annotation Term="Validation.Pattern" String="^([0-9A-Fa-f]{2}:){0,}([0-9A-Fa-f]{2})$"/>
464 </Property>
465 <Property Name="FingerprintHashAlgorithm" Type="Edm.String" Nullable="false">
466 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
467 <Annotation Term="OData.Description" String="The hash algorithm for the fingerprint of the certificate."/>
468 <Annotation Term="OData.LongDescription" String="The value of this property shall be a string containing the hash algorithm used for generating the Fingerprint property. The value shall be one of the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'."/>
469 </Property>
470 <Property Name="SignatureAlgorithm" Type="Edm.String" Nullable="false">
471 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
472 <Annotation Term="OData.Description" String="The algorithm used for creating the signature of the certificate."/>
473 <Annotation Term="OData.LongDescription" String="The value of this property shall be a string containing the algorithm used for generating the signature of the certificate, as defined by the RFC5280 'signatureAlgorithm' field. The value shall be a string representing the ASN.1 OID of the signature algorithm as defined in, but not limited to, RFC3279, RFC4055, or RFC4491."/>
474 </Property>
475 </EntityType>
476 </Schema>
477
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600478 </edmx:DataServices>
479</edmx:Edmx>